Webhook Types
There are a variety of webhook types you can set up:
Delete Campaign
Delete Custom Field
Delete Employee
New ADF Email
New Call
New Campaign
New Campaign Communication Transaction
New Communication Disposition
New Custom Field
New Email
New Email Event
New Employee
New Incoming Phone Number Order
New Message
New Opt In Out
New Organization
Update Campaign
Update Custom Field
Update Employee
Update Incoming Phone Number Order
Valid Prospect Import
To set up your webhooks, we’ll need the following information:
What URL would you like us to use?
What request type and body type would you like us to use?
What parameters would you like included (what is the spelling and syntax for these parameters)?
To set up a webhook:
From Admin, select Webhooks under Data Settings.
This page displays all active webhooks in your account. Use the orange pencil icon to edit or the plus button (next to Search) to create a new webhook.
(continued below)
To set up a webhook: (continued)
Click the plus button to create a new webhook, and you’ll be prompted to select:
Name - for internal use
Webhook Type - what is the event that will trigger the webhook
Request Type - GET or POST
URL - where the data will point to
Body Type - application/json, form-data, etc.
Are you including parameters in the body?
Are you including parameters in the URL?
(continued below)
Parameters:
To edit your new webhook and add parameters, click the orange edit icon on the far right.
To receive only calls that were dispositioned by an agent,, click the orange edit icon in the Details section. Check the Require a disposition box. Note: If checked, webhooks for unanswered calls will not be sent.
When setting up a parameter, you will be prompted to enter the external field. This is the field you want to map to in your external system.
Click the gray Add Parameter button, and add in your External Field and Parameter Type.
(continued below)
Parameters: (continued)
Here are some commonly used parameters for a new call event webhook:
Appointment Date/Time
Customer Cell Phone / Customer Home Phone / Customer Work Phone
Customer Email Address
Customer First Name / Customer Last Name
Customer Address / Customer City / Customer State / Customer Postal Code
Organization Name
Campaign Name
Vehicle Make / Vehicle Model / Vehicle Year
Survey Attempt Notes (call notes)
Call Recording URL
Agent Talk Duration
Friendly Direction
Hold Direction
etc…
Here are some commonly used parameters for a new email event webhook (incoming or outgoing). There is also a separate webhook type for email events like clicks and opens.
Body URL
Created At
Direction
Email Key
From Address / From Name
Is Sent
MME Type
Noticeable Type
Organization Key
Parent EMail Key
Reply To Address / Reply To Name
Sent At
Sid
Subject
To Address
To Name
Updated At
etc…
(continued below)
Parameters: (continued)
To trigger the webhook for specific campaigns or organizations, add them to the webhook.Only those listed will trigger the webhook.
Leaving it blank will trigger the webhook for all organizations and campaigns.
(continued below)
Send Test Webhook / Preview Webhook:
Once you have all your parameters added to the webhook, you can Preview it and send a test.