Create event subscription

POST

/subscriptions

Last modified:2026-10-30 21:35:31

OperationId:CreateSubscription

Creates a subscription that sends events of one model to your post-url as they happen. Create one subscription per model. Requires Basic User, Site Manager, Office Manager, Reseller, or Super User scope, and read access to the model. Check delivery with GET /subscriptions/{id}, and extend subscription-expires-datetime before it passes.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Responses

🟢200OK

application/json

The new subscription, returned once it is stored. The call waits up to 5 seconds for that, and delivery starts within about 5 seconds after.

Bodyapplication/json

🟠404

🟠400

🟠401

🟠409Conflict

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

cURL

Example 1Domain-wide call eventsOne user's CDRs

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/subscriptions' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "post-url": "https://core1.example.com/log.php",
    "model": "call",
    "user": "*",
    "reseller": "*",
    "domain": "*",
    "user-scope": "Super User",
    "subscription-geo-support": "yes",
    "server_preferred": "core1.example.com"
}'

Response Example

200 - Domain-wide call events

The new subscription. status stays pending until the first delivery.

{
    "id": "9f86d081884c7d659a2feaa0c55ad015",
    "model": "call",
    "post-url": "https://webhook.example.com/events",
    "subscription-geo-support": "yes",
    "user-scope": "Reseller",
    "reseller": "example-reseller",
    "domain": "example.com",
    "user": "*",
    "subscription-creation-datetime": "2026-09-01T14:30:00+00:00",
    "subscription-expires-datetime": "2027-09-01T14:30:00+00:00",
    "preferred-server": "core1.example.com",
    "current-active-server": null,
    "status": "pending",
    "error-count": 0,
    "posts-count": 0
}

Modified at 2026-10-30 21:35:31

Read event subscription

Update event subscription