Get a single subscription

The GET /subscriptions/{subscriptionId} endpoint returns information about a single subscription.

Headers

Header parameters in Requests (Webhooks API) apply to this endpoint.

Authorization scopes required:

Parameters

The endpoint accepts the following path parameter:

subscriptionId

The unique identifier for the subscription.

Requests

Requests a single subscription

curl -L -X GET "https://***.api.newvoicemedia.com/webhooks/subscriptions/2V1dP1RidyufqyPHlng0VJpGF3i" \
-H "Authorization: bearer <ACCESS_TOKEN>" \
-H "Accept: application/vnd.newvoicemedia.v1+json"

Responses

Response returns a single subscription, if one is found with the same subscription ID.

Successful response

Success response code and parameters in Requests (Webhooks API) apply to a successful response.

Example response

{
    "subscriptionId": "2V1EhIxvsBPpnqf6Hqv9mtPZx1a",
    "name": "My app",
    "url": "https://your-application.com/webhooks/events",
    "events": [
        "agent.presencechanged.v1"
    ],
    "enabled": true
}

The subscription contains the following parameters:

• subscriptionId — The unique identifier for the subscription. This ID can be used to edit or delete the subscription.
• name — The name for the subscription, specified during the creation of the subscription. The name is unique.
• url — The URL that the webhook events are sent to. It is a fully qualified https URL.
• events — A list of the event types that are subscribed to and are sent to the URL. Each item in the list is the name of an event type.
• enabled — Indicates whether the subscription is enabled. Notifications are only sent to the URL if the subscription is enabled.