Metadata 🔌

In order to add more flexibility and make your integration easier, we provide you with a way to include your own metadata to our entities. This means that you can add attach additional pieces of information, such as your internal IDs.

You can add your own metadata by sending key-value pair as a JSON object.

For example:

{
  "metadata": {
    "my_own_internal_id": "1234",
    "my_own_status": "pending-review"
  }
}

Custom fields

You can define which metadata fields you want to add as "Custom Fields" within the Management UI. This means you can add a field to the Customer entity called my_own_internal_id and then you can use it as a regular field in the Management UI.