This guide is intended to help with two things:
- Show you how to setup webhook actions in FLG.
- Outline the format that the webhook data will be sent in.
1. How to Setup Webhook Actions
Webhook actions can be setup in lead types and workflows.For lead actions, these are added in Settings > Lead Groups > Lead Types.
Select 'Edit' on the lead type that you'd like to add the webhook action to.
Click on 'Add New Action'.
Select 'Webhook' from the list of actions and then click to configure.
For the custom URL, specify the endpoint that you want the webhook to send to. You can also change the event that you would like the webhook to run on. (See the lead actions guide for more information on the different events).
Once the webhook action is saved you'll see it in the list of actions for the lead type.
You can also add webhook actions into workflows. This is done by heading to Settings > Workflows. An existing workflow can be used or you can create a new one.
Just like with the lead actions, you click to add an action and then configure the webhook:
2. Webhook Data Format
content-length: 12345
content-type: application/x-www-form-urlencoded
Note that the content-length will vary based on the data sent.
The below table lists the fields outputted by the webhooks.
| 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 From |
| 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. |
* Note: This is related to the 'Set Appointments' lead referral method and not the Appointments feature.
Need more help?
We always aim to provide great support to everyone. Contact our support team for help and advice or let us know how we can improve FLG on our feedback site.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article