For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Atlas Portal
DocsAPI Reference
DocsAPI Reference
  • Overview
    • API Overview
  • Atlas API
      • GETGet a sample event payload
      • POSTSubscribe to an event (create webhook)
      • DELUnsubscribe from an event (delete webhook)
      • GETList webhooks for a campaign
Atlas Portal
LogoLogo
Atlas APIEvents Gateway

Subscribe to an event (create webhook)

POST
https://api.youratlas.com/v1/api/events-gateway/trigger/subscribe
POST
/v1/api/events-gateway/trigger/subscribe
$curl -X POST https://api.youratlas.com/v1/api/events-gateway/trigger/subscribe \
>     -H "api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "hookUrl": "https://webhooks.example.com/atlas/call-started",
>  "campaignId": "a1b2c3d4e5f6g7h8i9j0",
>  "triggerName": "call_started",
>  "provider": "custom"
>}'
1{
2  "id": "sub_1234567890abcdef",
3  "campaignId": "a1b2c3d4e5f6g7h8i9j0",
4  "triggerName": "call_started"
5}

Registers a webhook. Atlas will send an HTTP POST to hookUrl every time the chosen event fires for the campaign.

Was this page helpful?
Previous

Unsubscribe from an event (delete webhook)

Next
Built with

Authentication

api-keystring

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

Request

This endpoint expects an object.
hookUrlstringRequiredformat: "uri"
HTTPS URL that Atlas will POST the event payload to.
campaignIdstringRequired

ID of the campaign to subscribe to. Use ”*” to receive the event from every campaign.

triggerNameenumRequired
The event that triggers webhook delivery.
Allowed values:
providerenumRequired

Identifies the webhook integration. For direct API usage this is always custom.

Allowed values:

Response

Subscription created
idstring

Identifier of the subscription (the registered hookUrl).

campaignIdstring
triggerNameenum
The event that triggers webhook delivery.
Allowed values:

Errors

400
Bad Request Error
500
Internal Server Error