Skip to content

Meta

Meta objects are used to describe the metadata of a resource. They are used to describe the resource's type, its relationships, and its attributes. Meta objects are optional and can be customized via the api or default configuration.

Structure

[key: string]: string | number | object | array

A metadata object consists of arbitrary key-value pairs.

Example Object

{
  "external-resource-name": "specific-resource-2",
  "external-resource-id": 234,
  "payload": {
    "key": "value",
    "key2": 123,
    "key3": {
      "key": "value"
    },
    "key4": [
      "value",
      123,
      {
        "key": "value"
      }
    ]
  }
}