Skip to main content
CallSprout

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

  1. Step 1:
    Open webhooks
    In the admin portal, go to Event Publisher, then Webhooks, and select Add webhook.
  2. Step 2:
    Name it
    Enter a Name that's unique on your account, and a description if you like. Leave Active at No for now.
  3. Step 3:
    Enter the address
    In URL, enter the address that will receive events. Add any fixed Headers your receiver expects. They're sent exactly as you type them.
  4. Step 4:
    Choose how it signs in
    Pick an option under Auth that matches your receiver. See the table below.
  5. Step 5:
    Pick events
    Switch 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.
  6. Step 6:
    Save
    Save the webhook.

Sign in options

Webhook authentication choices
OptionWhat you enter
No AuthNothing. Requests go out without credentials.
Basic AuthA username and password.
Bearer TokenA token.
OAuth client credentialsA token address, client ID and client secret. This suits a server receiving events from another server.
OAuth resource owner passwordA 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

Call events
EventSent when
call.event_call_startedA new call starts.
call.event_call_connectedThe call is answered.
call.event_call_updatedThe call changes state, for example when it leaves a queue on Contact Center Pro.
call.event_call_finishedThe call ends.
call.customer_interactionA finished call involved an outside number. Handy for logging customer calls.
call.voicemail_receivedA 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

  1. Step 1:
    Open the test panel
    In the webhook's Request section, select Test.
  2. Step 2:
    Send a sample
    Edit the sample body if you want, then send it.
  3. Step 3:
    Read the result
    The panel shows whether your address could be reached and what it sent back.
  4. Step 4:
    Turn it on
    When 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.

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.

Get a live call from our AI agent in about 10 seconds.