Webhook

Webhooks are an easy way to trigger new calls in Call Assist. They can be used with any application that can send a webhook.

Use the webhook integration to:

  1. Trigger a call to a Team when new leads come in.
  2. Trigger a call to a Lead at a scheduled time or after a specific action.

Creating a Webhook Integration #

Webhook integration are created from Integrations -> Webhooks

  1. Under the integrations column, Create a new Webhook integration.
  1. Name the webhook integration. It’s best to name it after the application or tool you are integrating with.
  2. Select the Team you want this integration to target.

    – Creating multiple webhook integrations allows you to target different teams.

    – You will define the type of call to make in the webhook payload.

    – All of your call settings are controlled from the Team record.
  3. Optionally customize the Webhook Fields.

    Webhook fields allow you to map custom keys to Call Assist fields. You can use the default values or change to fit your integration needs.

    The webhook can receive any of the following values:

Default Webhook values:

  • Phone (required) – Lead phone number
  • type – (required) – {“lead” or “target”} – The type of call to make.

    lead: Calls the Lead, plays recorded message, Lead dials 1, calls Team.
    team: Calls Team, plays whisper text, Agent dials 1, calls Lead.
  • source – (optional) – Define what triggered the call. For reporting purposes only.
  • First Name – (optional) – Lead first name
  • Last Name – (optional) – Lead last name
  • Company – (optional) – Lead company
  • Email – (optional) – Lead Email
  • Category – (optional) – Lead Category

Using a Webhook Integration #

  1. Navigate to Integrations.
  2. Click the Instructions button besides the webhook you want to integrate.
  1. Webhook Instructions are displayed.

    Webhook Url is the endpoint url your integration should target.
    Payload is the JSON object your webhook should send to Call Assist.
  1. Send a POST request to Call Assist.

    Make a POST request to the Webhook Url with the Payload from Step 3 (above). The POST request can send JSON or form data.
POST https://app.mycallassist.com/webhook/c712c41c-455a-5de0
{ 
  "phone": "15555555555", 
  "type": "lead",
  "source": "webhook", 
  "fname": "John",
  "lname": "Smith", 
  "company": "Zoomer Media", 
  "email": "jsmith@example.com", 
  "category": "Aging leads"
}


If the POST is successful, you will receive a status 200 response and a call will start. Depending on the call type, a lead or team will be called.

{ "status":"success" }

Modifying a Webhook Integration #

  • You can disabled a webhook integration using the On / Off toggle.
  • Settings let you modify any of the webhooks configuration.

Advanced Configuration #

You can override Team Settings that control the call by also providing any of the following optional parameters.

callMode: {"round robin" or "simultaneous"} The method Call Assist uses to call your Team.

recordCall: {boolean} Whether to record the call or not.

callerId: {number} A verified phone number to use as caller id.

whisperText: {string} Whisper text to play before connecting an agent with a lead. May include lead references .{first} {last} {company} {category} {comments}

whisperLanguage: {language} Whisper text language.
"en-US","es-ES","fr-FR","it-IT","de-DE","nl-NL","pt-BR"

delay: {Integer} Minutes to delay the call.

hasSchedule: {boolean} Whether the team has an on-call scheduled.

callback_url: {URL} Url to send call completed events.

recording: {recordingId} - UUID of the recording resource you would like to use. You can find at Recording -> Edit Recording

voicemail: {recordingId}- UUID of the recording resource you would like to use. You can find at Recording -> Edit Recording

optOut: {boolean} Whether to include opt out message at end of lead calls.