Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

...

TypeRequiredExample
StringTrue2V1d4FfmK5ho8aiomIwP9QdpQjv

The unique identifier for the subscription.

...

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

...

Code Block
languagejs
themeMidnight
{
    "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
nopaneltrue
Insert excerpt
_ExcerptRunInPostman
_ExcerptRunInPostman
nopaneltrue