Page Comparison

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

Insert excerpt

	_ExcerptSubscriptionChangeDelay
	_ExcerptSubscriptionChangeDelay
nopanel	true

Panel

borderColor	#eeeeee
bgColor	white
titleColor	white
borderWidth	1
titleBGColor	#D6219C
borderStyle	solid
title	In this page

Table of Contents

...

Type	Required	Example
String	True	2V1d4FfmK5ho8aiomIwP9QdpQjv

The unique identifier for the subscription.

...

Code Block

language	js
theme	Midnight

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

...

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.

...

Code Block

language	powershell
theme	Midnight

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

...

Code Block

language	js
theme	Midnight

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

The response contains the following properties:

Insert excerpt

	_ExcerptAPISubscriptionWebhooks
	_ExcerptAPISubscriptionWebhooks
nopanel	true

Insert excerpt

	_ExcerptRunInPostman
	_ExcerptRunInPostman
nopanel	true

Versions Compared

Old Version 3

New Version Current

Key