v50

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

webhooks

Get Message

Retrieve a specific webhook message by its ID.

Returns the full message details including the event type, payload data, timestamp, and delivery channel information. Use this to inspect the exact payload that was sent to your webhook endpoints.

Use include_attempts=true to also retrieve delivery attempts for this message, which include HTTP response codes, response bodies, and timestamps for debugging delivery failures.

get/webhooks/messages/{message_id}

Path parameters

message_idstring required

The unique identifier of the message to retrieve (UUID).

Example:550e8400-e29b-41d4-a716-446655440000

The unique identifier of the message to retrieve (UUID).

Query parameters

include_attemptsboolean

Include delivery attempts for this message. Each attempt includes the HTTP response code, response body, and timestamp.

Response

Webhook message details

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"
}