Atlas APIEvents Gateway

Get a sample event payload

Returns an example payload for the given event, built from real data in the specified campaign. Use it to build and test your webhook receiver before subscribing.

Authentication

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

Path parameters

triggerNameenumRequired
The event to build a sample payload for.
Allowed values:

Query parameters

campaignIdstringRequired
The campaign to build the sample payload from.

Response

Sample event payload. The shape of each item depends on the triggerName path parameter.

CallStartedEventobject
Payload delivered when a call starts.
OR
CallCompletedEventobject
Payload delivered when a call ends. Includes the call result.
OR
MessageReceivedEventobject

Payload delivered when a customer message is received. Note: this payload carries no sessionId and no message id — to attribute or dedup a message you must re-pull the session/messages via the REST API. (message_session_completed does include sessionId and a messages[] array.)

OR
MessageSentEventobject

Payload delivered when the agent sends a message. Note: like message_received, this payload carries no sessionId and no message id — attribution/dedup requires a REST re-pull.

OR
ConversationCompletedEventobject

Payload delivered when a messaging conversation ends after a period of inactivity. Includes the full message history and an AI-generated summary.

Errors

400
Bad Request Error
500
Internal Server Error