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

Unsubscribe from an event (delete webhook)

DELETE
https://api.youratlas.com/v1/api/events-gateway/trigger/unsubscribe
DELETE
/v1/api/events-gateway/trigger/unsubscribe
$curl -X DELETE https://api.youratlas.com/v1/api/events-gateway/trigger/unsubscribe \
>     -H "api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "hookUrl": "https://webhooks.example.com/atlas/call-started",
>  "campaignId": "campaig-1234abcd5678efgh",
>  "triggerName": "call_started",
>  "provider": "custom"
>}'
1{}
Removes a previously registered webhook so Atlas stops delivering the event.
Was this page helpful?
Previous

List webhooks for a campaign

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"
The same URL used when subscribing.
campaignIdstringRequired
The campaign the webhook was registered for.
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 removed

Errors

400
Bad Request Error
500
Internal Server Error