v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-222763184.3 KB

webhooks

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.

get/webhooks/messages

Query parameters

event_typesstring[] nullable

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

[
  "sync.completed",
  "sync.failed"
]

Response

List of webhook messages

idstring required

Unique identifier for this message (UUID format)

event_typestring required

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

payloadobject required

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

timestampstring date-time required

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

channelsstring[] nullable

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

tagsstring[] nullable

Tags associated with this message for filtering

Example response

[
  {
    "channels": [
      "sync.completed"
    ],
    "event_type": "sync.completed",
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "payload": {
      "collection_name": "Customer Support Tickets",
      "collection_readable_id": "customer-support-tickets-x7k9m",
      "event_type": "sync.completed",
      "job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "source_connection_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "source_type": "zendesk",
      "status": "completed",
      "timestamp": "2024-03-15T09:45:32Z"
    },
    "timestamp": "2024-03-15T09:45:32Z"
  }
]