Add and test a webhook
Receive call and contact events at your own https endpoint, signed so you can check they came from CallDesk.
Where to find it
Voice › Voice overview › Developers
Open this screen
Steps
- Open Voice › Voice overview and press Open the page on Developers.
- In Webhooks, press Add endpoint.
- Enter the Endpoint URL (a public https address) and tick the Events you want. None ticked means all events.
- Press Add endpoint, then press Copy next to Signing secret and keep it safe. Press Done.
- Press Send test on the endpoint's row and read the result. Press Delete to remove an endpoint.
Settings on this screen
| Setting | What it does | Default |
|---|---|---|
| Endpoint URL | Where events are sent. Public https only. | — |
| Events | Which events to send. | All events |
| Signing secret | Shown once. X-CallDesk-Signature is the HMAC-SHA256 of "timestamp.body" with it; the timestamp is in X-CallDesk-Timestamp. | — |
Troubleshooting
"A webhook can only reach a public https address. Private, local and cloud-metadata addresses are refused."
Use a public https URL.
Tips
- Each row shows the last HTTP status, when it was sent and how many deliveries failed.
Good to know
- Up to 20 endpoints per organisation.
- Only managers can add, test or delete endpoints.