Subscribes a target_url to one or more events. Ringover will POST the payload of each subscribed event to that URL.

The response contains the uuid of the webhook, which you then use to read, update or delete it, and the signing_key to verify the signature of the deliveries you receive.

Re-posting a target URL that is already subscribed is not an error: the events of the request are merged into the existing subscription, and the same uuid is returned. Use this to add events idempotently when you do not know the current state.

Creating your first webhook also turns webhook delivery on, so there is nothing to activate in the dashboard beforehand.

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

Monitoring: Not needed. The webhook is created in the configuration attached to your API key.

{
  "target_url": "https://api.example.com/webhooks/ringover",
  "events": [
    "call.started",
    "call.answered",
    "call.ended"
  ]
}

{
  "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"
  }
}