Get a sample event payload | Atlas

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

campaignIdstring

agentIdstring

callIdstring

customerNumberstring

customerNamestring

campaignNamestring

agentNamestring

campaignTypestring

Errors

400

Bad Request Error

500

Internal Server Error

$	curl -G https://api.youratlas.com/v1/api/events-gateway/trigger/perform/call_started \
>	-H "api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d campaignId=campaignId

1	[
2	{
3	"campaignId": "campaig-9f8b7d6e5a4c3b2a1d0e",
4	"agentId": "agent-12345abcde67890fghij",
5	"callId": "call-20240603123045987654",
6	"customerNumber": "+14155552671",
7	"customerName": "Emily Johnson",
8	"campaignName": "Spring Product Launch",
9	"agentName": "Michael Thompson",
10	"campaignType": "outbound"
11	}
12	]