What data is sent to your webhook?

[API Docs] [SDK]

Webhooks have different payload structures depending on its trigger type. The most common event is the Automation Trigger Webhook event. Once this event is selected, you are able to trigger a webhook request within an automation. The other use case is the Portal Access Entity Access event, which is triggered when a user accesses an entity in the portal. This event is used to track user access to entities and can be used to trigger webhooks based on user actions.

The following section describes the payload structure for both event types.

Every webhook event always contains a metadata object, which includes the organization ID and other metadata related information about the event. The entity object contains the entity data, while the relations and activity objects are optional and can be included based on the webhook configuration.

{
   "metadata": {
      "organization_id": "org_1234567890",
      "event_type": "automation_trigger_webhook",
      "timestamp": "2023-10-01T12:00:00Z"
   },
   "entity": {
      "_id": "123456",
      "_schema_": "opportunity",
      "name": "New Opportunity",
      "status": "open"
   },
   "relations": [
      // optional relations to other entities
   ],
   "activity": {
      // optional activity data
   },
   "changed_attributes": {
      "added": {},
      "deleted": {},
      "updated": {}
   }
}

The flow can be nailed down to a simple overview with the following steps:

1. You configure a trigger for the webhook
2. If the trigger is of type Portal Access, you get a webhook request every time a user accesses (login) its portal account.
3. If the trigger is of typ Automation Trigger, you can connect a webhook action in the automation configuration.
4. You can configure a JSONata query in the webhook config to further transform the payload to your needs

Read the following pages to learn more about the different webhook trigger types.