Getting Started with Webhook

Here is the video illustrating the procedure of creating Webhooks.

Webhooks are user-defined callbacks that are triggered by specific events. They help start the execution of a particular task when specific actions take place and push data from one application or server to another on the occurrence of an event (also called trigger). They are useful for the integration of Smartflo with the CRMs of your choice. Also, they provide responses in real-time and hence, eliminate delays in accessing important information.

You can configure Webhook by setting up the HTTP Method, and URL to receive data, and selecting the trigger options, all explained below in detail. Follow the below-mentioned steps to add a Webhook:

  1. Go to Services > Webhook.

  2. Click Add Webhook.

  1. Enter the general details as per the fields described in the table below.

[block:image]
{
"images": [
{
"image": [
"https://files.readme.io/cca02a9-Webhook.png",
null,
null
],
"align": "center"
}
]
}
[/block]

FieldDescription
NameEnter the name of the Webhook.
DescriptionAdd the Description.
TriggerChoose the trigger from the dropdown. A trigger is a predefined action or a notification that activates Webhook.
The below-mentioned triggers or the automated processes are generated for both inbound and outbound calls, which are as follows:
  • Call received on Server
  • Call answered on IVR
  • Call answered by Agent
  • Call hangup (Missed)
  • Call hangup (Answered)
  • Call hangup (Missed or Answered)
  • DTMF Option
  • Dialed on Agent
  • Call received on Department
  • Call received on Auto Attendant
  • Call answered by Agent (Hangup)
  • Call missed by Agent (Hangup)
  • Call answered by Customer (Click to call)
  • Call missed by Customer (Click to Call)
  • Disposition Status Updated (Dialer)
  • Call Connected to Agent (Dialer)
  • Session Call Answered
    URLEnter the URL to provide HTTP callbacks for the Webhook.
    RequestSelect a request from either of the following options: POST or GET.
    Note: The exchange of data happens over the web through an HTTP request, using GET & POST methods.
    Call TypeSelect the required Call Type from either of the following options:
    • Inbound
    • Outbound
    Content-TypeSelect the Content-Type that contains the data from either of the following body types:
    • application/x-www-form-urlencoded: The content body is in HTML format.
    • application/json: The content body is in JSON format.
    Outbound TypeSelect the Outbound-Type that contains the data from either of the following body types:
    • Click to Call:
    • Call Broadcast:
    • Dialer:
    My NumbersSelect the required numbers from the dropdown.

    Note: While configuring the triggers, Webhook sends an HTTP request encompassing various parameters to different endpoints. These parameters form the Response Body as demonstrated in the screenshot. Also, the parameters change as per the selected trigger.

    Webhooks

    1. Click Add header and enter the key and the value to insert additional values in the Response Body.

    Webhooks

    1. Click Save.