Working with Webhooks

Modified on Wed, 24 Jun at 2:52 PM

Webhook Actions

This guide covers:

How to set up webhook actions in FLG
The format that webhook data is sent in

Setting Up Webhook Actions

Webhooks 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 want to add a webhook to
Click Add New Action
Select Webhook from the list and click to configure
Enter the custom URL - the endpoint the webhook will send to
Once saved, the webhook appears in the lead type's action list

Workflow Webhooks

Go to Settings - Workflows and open or create a workflow
Click to add an action, then configure the webhook with your endpoint and trigger event

Webhook Data Format

Webhooks send data via HTTP POST with these 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
email	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	Google	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 and 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	Whether there is an active task on the lead (Yes or No)
workflowexists	No	Whether 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 and 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 and Time of the event that triggered the webhook
appointmentdatetime	2019-10-20 15:00:00	Date and 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 - format is j followed by the field name