Skip to content

Webhook Notification Example

POST https://your.endpoint.here

This example shows the notification request your endpoint will receive when a notification is sent. There can be 0 or more secret fields shown, depending on the initial webhook configuration. The "updated_attributes" field only shows up on an "update" event. The "timestamp" field is an ISO 8601 timestamp string.

Request Body Template

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "ids": [<entity_id_1>, <entity_id_2>, ...],
  "type": "<entity_type>",
  "event": "<event_type>",
  "subscription_id": <subscription_id>,
  "secret_field_1": "<string>",
  "secret_field_2": "<string>",
  "updated_attributes": {
    "field_name": [<old_value>, <new_value>]
  },
  "timestamp": "<string>"
}

Request Body with Non-Computed Custom Fields (Default)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
  "ids": [
    123
  ],
  "secret": "secret",
  "key": "key",
  "subscription_id": 1,
  "event": "update",
  "type": "person",
  "updated_attributes": {
    "custom_fields": {
      "1": [
        [ 1 ],
        [ 1, 2 ]
      ]
    }
  },
  "timestamp": "2021-12-13T19:18:22.084Z"
}

Request Body with Computed Custom Field Values

Note: Dropdown/Multi-Select Dropdown Custom Fields are only converted to their name values when the Webhook subscription instance has custom_field_computed_values set to true.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
  "ids": [
    123
  ],
  "secret": "secret",
  "key": "key",
  "subscription_id": 1,
  "event": "update",
  "type": "person",
  "updated_attributes": {
    "custom_fields": {
      "1": [
        [ "Apples"],
        [ "Apples", "Bananas" ]
      ]
    }
  },
  "timestamp": "2021-12-13T19:18:22.084Z"
}