API ReferenceWebhooks

List Messages

Retrieve all webhook messages for your organization. Webhook messages represent payloads that were sent (or attempted to be sent) to your subscribed endpoints. Each message contains the event type, payload data, and delivery status information. Use the `event_types` query parameter to filter messages by specific event types, such as `sync.completed` or `sync.failed`.

Authentication

x-api-keystring
API Key authentication via header

Query parameters

event_typeslist of strings or nullOptional

Filter messages by event type(s). Accepts multiple values, e.g., ?event_types=sync.completed&event_types=sync.failed.

Response

List of webhook messages
idstring

Unique identifier for this message (UUID format)

event_typestring

The type of event (e.g., ‘sync.completed’, ‘sync.failed’)

payloadmap from strings to any

The event payload data, matching what is delivered to webhooks. Structure varies by event_type.

timestampstringformat: "date-time"

When this message was created (ISO 8601 format, UTC)

channelslist of strings or null

Channels this message was sent to (typically matches the event type)

tagslist of strings or null
Tags associated with this message for filtering

Errors

422
Unprocessable Entity Error
429
Too Many Requests Error