Sign in
latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

webhook

Add events to a webhook

Adds events to a webhook, keeping the ones it is already subscribed to. The resulting set is the union of both, so re-sending an event that is already subscribed has no effect.

To unsubscribe events, send the desired list to PUT /webhooks/{webhookId}/events.

The target URL is immutable, so the uuid of the webhook does not change.

Permission: No specific permission required. A valid API key is sufficient.

Monitoring: Not needed.

patch/webhooks/{webhookId}/events

Path parameters

webhookIdstring uuid required
Example:bc5c5a41-44c5-5b7c-a521-45bf56d82cbe

The identifier of the webhook, as returned in the uuid field.

Request body

eventsWebhookEvent[] required

The events to apply to the subscription (mandatory, at least one, no duplicates).

Example request

{
  "events": [
    "call.missed",
    "call.voicemail"
  ]
}

Response

Successful operation — returns the updated subscription.

uuidstring uuid required

The identifier of the webhook: an RFC 4122 v5 UUID derived from target_url in the URL namespace. The same target URL always yields the same identifier, and it is stable for the lifetime of the subscription.

target_urlstring uri required

The URL Ringover POSTs the subscribed events to. Immutable.

eventsWebhookEvent[] required

The events delivered to target_url, in catalog order.

signing_keystring

The key used to sign the deliveries sent to your endpoints (see Securing your webhooks in the webhook tag description). Read-only and shared by every subscription of your configuration. Absent while no key has been generated yet.

Example response

{
  "uuid": "bc5c5a41-44c5-5b7c-a521-45bf56d82cbe",
  "target_url": "https://api.example.com/webhooks/ringover",
  "events": [
    "call.started",
    "call.answered",
    "call.ended"
  ],
  "signing_key": "b7c1f2e4a9d84c3f8e5b6a7d9c0e1f23"
}