Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »


Beta/Early Access Program

This API is in the Beta/Early Access Program and is still under development. If you are interested in using this API, please contact your Customer Success Manager or Account Manager. Participation in this pilot program is at the discretion of Product Management and not guaranteed.

Use of this API outside of the program is prohibited.

The PATCH /subscriptions/{subscriptionId} endpoint can be used to update an existing subscription.

In this page


Most URLs in the example code use the following values:

Headers

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

Authorization scopes required:

Scope
admin:write

Parameters

The endpoint accepts the following path parameter:

subscriptionId

TypeRequiredExample
StringTrue2V1d4FfmK5ho8aiomIwP9QdpQjv

The unique identifier for the subscription.

Body

{
  "name": "My app",
  "url": "https://your-application.com/abc/123",
  "events": [
    "agent.presencechanged.v0",
    "channel.connected.v0"
  ],
  "enabled": false,
  "secret": "OFe4WHqXISxMAgoYneiFhgdGrOgYeToYPN3HjIO4xAxDvWd/oIKTW1P4A6GLXN0McDGlLtnTn1KCGCa+W5Gu="
}

An object containing the subscription properties to change should be included in the body. It may contain any of the following properties:

  • name — The name of the subscription. The name must be unique.
  • url — The URL that the webhook events are sent to. It must be a fully qualified http or https URL.
  • events — A list of the event types you wish to receive webhook notifications for. Each item in the list must be the name of an event type. You can get a list of event types to discover their names.
  • enabled — Notifications will only be sent to the URL if the subscription is enabled.
  • secret — The secret used to sign notifications. 

Any properties not specified will remain unchanged.

Requests

Update the specified subscription

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

Responses

The response returns the new value of the subscription.

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.v0",
        "channel.alerting.v0"
    ],
    "enabled": false
}

The response contains the following properties:

  • 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.

  • No labels