webhook

List webhooks

Changed on

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

Request

  • Base URL
    https://public-api.ringover.com/v2
  • URL
    https://public-api.ringover.com/v2/webhooks
  • Auth
    API key in header Authorization

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",
      "event_signing_keys": {
        "contact.call": "3f9a1c7e2b8d4f6a0e5c9b1d7a3f2e8c4b6d0a19",
        "contact.search": "8e2d4b6f1a9c3e7d5b0f2a4c6e8d1b3f5a7c9e02"
      }
    }
  ]
}

Changes

  • 1d700a84e7b0Revision changes
    • warning

      added the new sms.delivery_receipt enum value to the /// response property for the response status

  • 9e23e47609a5Revision changes
    • warning

      added the new contact.call enum value to the /// response property for the response status

    • warning

      added the new contact.search enum value to the /// response property for the response status

    • info

      added the optional property // to the response with the status