Read event subscription

GET

/subscriptions/{id}

Last modified:2026-09-27 19:29:26

OperationId:ReadSubscription

Returns one event subscription, with its delivery state: status, error-count, posts-count, and current-active-server.

Requires Basic User, Site Manager, Office Manager, Reseller, Super User, or Super User Read Only. Super User and Super User Read Only see every subscription. A Reseller sees the subscriptions in its own territory, except the ones a Super User created, and can narrow to one of its domains. Every other scope sees the subscriptions its own scope created in its own domain, and user-level scopes see only their own and domain-wide ones. Naming a domain you cannot see returns 403.

post-url comes back in full only when you can change the subscription. Otherwise its user-info, query string, and fragment are masked. A subscription you cannot see returns 404, the same as one that does not exist.

Use it after a create to see whether delivery works. status is error when a delivery failed in the last 5-second cycle.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200OK

application/json

The subscription.

Bodyapplication/json

🟠404

🟠401Authentication Required

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/subscriptions/9f86d081884c7d659a2feaa0c55ad015' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Active subscription

A domain-wide call subscription that is delivering.

{
    "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": "core1.example.com",
    "status": "active",
    "error-count": 0,
    "posts-count": 1520
}

Modified at 2026-09-27 19:29:26

List domain event subscriptions

Create event subscription