Subscribe

AQX

GET

https://api.aqx.ai/api/events-gateway/trigger/subscribe

This endpoint is used to subscribe to this event for this specific campaignId.

Request

Header Params

Content-Type

string

optional

Example:

application/json

Ocp-Apim-Subscription-Key

string

required

Example:

Authorization

string

required

Example:

Bearer {{user_access_token}}

Body Params application/json

hookUrl

string

required

hook url

campaignId

string

required

campaignID GUID

triggerName

string

required

event name ie (call_started, call_completed)

Example

{
  "hookUrl": "string",
  "campaignId": "string",
  "triggerName": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.aqx.ai/api/events-gateway/trigger/subscribe' \
--header 'Ocp-Apim-Subscription-Key: {{api-key}}' \
--header 'Authorization: Bearer {{user_access_token}}' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200Success

application/json

Body

string

required

hook url

campaignId

string

required

campaignID GUID

triggerName

string

required

event name ie (call_started, call_completed)

Example

{
  "id": "string",
  "campaignId": "string",
  "triggerName": "string"
}

User Info

Unsubscribe