POST
/
webhooks
This endpoint requires your private API key.

Once a webhook is created, events will be sent to it based on the criteria specified in the webhook. The data sent follows the Event schema and is sent as a JSON array in the POST request in the data field. Below is an example request body:

{
  "data": [
    {
      "uuid": "b99b40c5-e306-4351-9f1d-9a13bb9e8bd1",
      "type": "track",
      "event": "ConnectedAccount",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "properties": {
        "totalAccounts": 4
      },
      "timestamp": "2024-10-21T21:32:17.000Z",
      "parsedAt": "2024-10-21T21:32:23.194Z"
    }
  ]
}

Body

application/json
url
string
required

The URL that the webhook will send events to.

enableBatching
boolean

Whether to enable batching for the webhook. Defaults to false.

eventTypes
string[]

The event types that the webhook will send. Defaults to ["*"] (all event types).

eventNames
string[]

The event names that the webhook will send. Defaults to ["*"] (all event names).

Response

200 - application/json
uuid
string
required

The UUID of the webhook. Automatically generated.

url
string
required

The URL that the webhook will send events to.

enableBatching
boolean
required

Whether to enable batching for the webhook.

createdAt
string
required

The date and time the webhook was created.

eventTypes
string[]
required

The event types that the webhook will send. Use * to match all event types.

eventNames
string[]
required

The event names that the webhook will send. Use * to match all event names.

Was this page helpful?

Get WebhooksDelete Webhook