Understanding webhook payloads

Webhook payloads are event objects that contain data being sent from Website Toolbox to another service. The event object contains a data attribute and an object attribute within that. The object attribute will contain the object that the webhook event is about. The most common objects are documented in the API documentation. For example, in a user.updated webhook event, the data.object attribute of the payload will be a User object. We recommend reviewing the example webhook event.

There are some objects returned by webhook events that do not have associated API endpoints, hence they are not documented yet.

Every time a webhook event is sent, the payload and response will be recorded in the Integrate -> Webhook section. This is where you can review the payload to see what attributes were included or to determine if the data is what you were expecting.

If you still need help, please contact us.