Send call events to your own apps
- Audience: Admins
Last updated
A webhook tells another system about your calls as they happen. Each time a call event you've picked takes place, CallSprout sends a request with the call's details to a web address you provide. Companies use this to feed their own back end, an automation tool or a reporting database.
Some labels in your portal or apps may look slightly different from this guide.
Webhooks are for people comfortable with web services. Someone on your side has to run the address that receives the events. Ask support whether webhooks are turned on for your account.
Create a webhook
- Step 1:Open webhooksIn the admin portal, go to Event Publisher, then Webhooks, and select Add webhook.
- Step 2:Name itEnter a Name that's unique on your account, and a description if you like. Leave Active at No for now.
- Step 3:Enter the addressIn URL, enter the address that will receive events. Add any fixed Headers your receiver expects. They're sent exactly as you type them.
- Step 4:Choose how it signs inPick an option under Auth that matches your receiver. See the table below.
- Step 5:Pick eventsSwitch on the events you want, or choose Subscribe to all to get every current event and any added later. Use the details button next to an event to see which fields it carries.
- Step 6:SaveSave the webhook.
Sign in options
| Option | What you enter |
|---|---|
| No Auth | Nothing. Requests go out without credentials. |
| Basic Auth | A username and password. |
| Bearer Token | A token. |
| OAuth client credentials | A token address, client ID and client secret. This suits a server receiving events from another server. |
| OAuth resource owner password | A token address, client ID and secret, plus a username, password and optional scopes. Keep it for older receivers that need it. |
Call events you can send
| Event | Sent when |
|---|---|
call.event_call_started | A new call starts. |
call.event_call_connected | The call is answered. |
call.event_call_updated | The call changes state, for example when it leaves a queue on Contact Center Pro. |
call.event_call_finished | The call ends. |
call.customer_interaction | A finished call involved an outside number. Handy for logging customer calls. |
call.voicemail_received | A new voicemail comes in. Useful for alerts. |
Plan for a lot of traffic from a single call. Every change to the call sends a new event the moment it happens, covering the caller's side and the other party's side alike, so your receiver will often get several events for the same call.
Test before you turn it on
- Step 1:Open the test panelIn the webhook's Request section, select Test.
- Step 2:Send a sampleEdit the sample body if you want, then send it.
- Step 3:Read the resultThe panel shows whether your address could be reached and what it sent back.
- Step 4:Turn it onWhen the test looks right, set Active to Yes and save. The webhook starts sending the events you picked.
Manage webhooks
The Webhooks list shows each webhook's name, description, address and whether it's enabled, with buttons to edit or delete it. You can search it by name.
Don't see this option? Contact support and we'll set it up for you.
Related articles
Still stuck? Contact support
Our team in West Palm Beach can walk you through it. Tell us your name, your company and what you were trying to do.