Skip to navigation
API ReferenceWebhooks

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.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

message_idstringRequired

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

Query parameters

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

Response

Webhook message details
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 nullOptional

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

tagslist of strings or nullOptional
Tags associated with this message for filtering
delivery_attemptslist of objects or nullOptional
Delivery attempts for this message.

Errors

404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error