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

9da73dd2f99e

webhook

List webhooks

Retrieves every webhook subscription of your configuration: the target URLs Ringover delivers events to, and the events each one is subscribed to. The number of subscriptions is in the list_count field.

When you have never configured a webhook, the call still succeeds and returns an empty list with list_count: 0.

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

Monitoring: Not needed. The configuration returned is always the one attached to your API key.

get/webhooks

Response

Successful operation — returns your webhook subscriptions.

list_countinteger required

The number of webhook subscriptions in list.

Example response

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