Webhook payload format examples
The following sample webhook payloads show the parts of a payload and descriptions of each part.
For details on triggering webhooks, see Trigger webhooks for other applications.
Sample payload for an update event
The payload for an update event consists of the following parts:
Part | Description |
---|---|
Header information |
Sent with every Trigger webhook rule, and consists of:
|
Basic information |
Fields that are sent with every Trigger webhook rule. These fields include:
|
Additional information | Additional fields that you can add to the request payload, using Fields when setting up the Trigger webhook rule. |
Changes |
If the event_type is update, the changes field is included in the request payload. The changes field includes the set of changes, including the values before and after the update. |
Usage of payload field types
The following sample payload highlights the usage of various field types.