This guide covers two things:
How to set up webhook actions in FLG
The format that webhook data is sent in
How to Set Up Webhook Actions
Webhook actions can be set up in lead types and workflows.
Lead Type Webhooks
Go to Settings > Lead Groups > Lead Types.
Select Edit on the lead type you'd like to add the webhook action to.
Click Add New Action.
Select Webhook from the list of actions and click to configure.
In the configuration, specify the custom URL (the endpoint you want the webhook to send to)
Once saved, the webhook action will appear in the list of actions for the lead type.
Workflow Webhooks
Go to Settings > Workflows. Use an existing workflow or create a new one.
Just like with lead actions, click to add an action and then configure the webhook with your desired endpoint and trigger event.
Webhook Data Format
Webhooks send data using an HTTP POST with the following headers:
content-type: application/x-www-form-urlencoded
content-length: <varies based on data sent>
Fields
| Field | Sample | Notes | |
| id | 123456789 | Lead ID / Reference | |
| title | Mr. | Title | |
| firstname | Joe | First Name | |
| lastname | Bloggs | Last Name | |
| fullname | Joe Bloggs | Full Name | |
| address | 1 High Street | Address line 1 | |
| address2 | This Area | Address line 2 | |
| address3 | This Village | Address line 3 | |
| towncity | This Town | Town | |
| postcode | BB12 1BC | Postcode | |
| joe.bloggs@example.com | Email Address | ||
| phone1 | 01282123456 | Phone Number | |
| phone2 | 01282654321 | Alternative Phone Number | |
| fax | 01282321654 | Fax Number | |
| dob | 1990-12-15 | Full Date of Birth
YYYY-MM-DD | |
| dobday | 15 | Birth Day | |
| dobmonth | 12 | Birth Month | |
| dobyear | 1990 | Birth Year | |
| company | ABC Ltd. | Company | |
| jobtitle | Manager | Job Title | |
| leadgroupname | Mortgages | Lead Group Name | |
| leadgroupid | 12345 | Lead Group ID | |
| leadtype | General | Lead Type Name | |
| sitename | ABC Ltd. | Site Name | |
| siteid | 123 | Site ID | |
| status | Quoted | Lead Status | |
| username | Joe Bloggs | Assigned User Name | |
| userid | 1234 | Assigned User ID | |
| progress | Qualified | Billing Point | |
| source | Marketing Source | ||
| medium | PPC | Marketing Medium | |
| term | Loans | Marketing Term | |
| cost | 10 | Lead Cost | |
| value | 20 | Lead Value | |
| received | 2019-10-08 08:50:09 | Date & Time Lead Received
YYYY-MM-DD HH:MM:SS | |
| buyername | Partner Co. | Referral Partner Name | |
| buyerid | 1234 | Referral Partner ID | |
| buyerreference | Passed to Joe | Telephone Transfer Reference | |
| transferdatetime | 2019-10-11 14:23:02 | Telephone Transfer Date/Time
YYYY-MM-DD HH:MM:SS | |
| transfersuccessful | Yes | Telephone Transfer Success Result (Yes or No) | |
| subid | 1234-1234 | Sub Lead ID | |
| xmldatetime | 2019-10-11 14:23:02 | Internet Delivery Date/Time
YYYY-MM-DD HH:MM:SS | |
| xmlfails | 0 | Internet Delivery Outcome (0 = Success, 1 = Failed) | |
| xmlreference | 123456 | Returned Reference (if captured) | |
| xmlresult | Success | Returned Result (if captured) | |
| introducername | Introducer Co. | Introducer Name | |
| introducerid | 4321 | Introducer ID | |
| reference | 12345 | Introducer Reference.
Text input specified by the Introducer. | |
| contactemail | Yes | Permission to Email | |
| contactphone | Yes | Permission to Phone | |
| contactsms | Yes | Permission to SMS | |
| contactmail | No | Permission to Mail | |
| contactfax | No | Permission to Fax | |
| contacttime | Anytime | Contact Time Preference | |
| dropbox | abc123@msrvr.net | Lead Dropbox Address | |
| ipaddress | 62.123.456.789 | IP Address Lead Was Submitted Fr om | |
| data# (1 to 50) | User-defined | Additional Field Data | |
| type# (1 to 50) | User-defined | Additional Field Label | |
| taskexists | Yes | Signifies whether or not there is an active task on the lead. Yes or No. | |
| workflowexists | No | Signifies whether or not there is an active workflow on the lead. Yes or No. | |
| lastnote | Called Customer | Last note left on the lead. New > Telephone Call OR New > Note | |
| lastnotedatetime | 2019-10-11 15:00:49 | Date & Time of last note.
YYYY-MM-DD HH:MM:SS | |
| eventtype | status | Event type that triggered the webhook | |
| eventusername | Joe Bloggs | Name of user that triggered the event | |
| eventuserid | 123 | ID of user that triggered the event | |
| eventdatetime | 2019-10-20 15:00:00 | Date & Time of the event that triggered the webhook | |
| appointmentdatetime | 2019-10-20
15:00:00 | Date & Time of referral appointment.
YYYY-MM-DD HH:MM:SS * | |
| appointmentnotes | Call landline number | Notes associated with referral appointment * | |
| j | User-defined | Journey field data. The format is j followed by the field name. |