How LeadByte clients use Webhooks

The majority of our clients use Webhooks to send event data in real-time to another end-point (often an app, crm, database). Zapier is a common end-point!  Webhooks would mostly be used by technical users but the likes of Zapier have made it super simple to "catch a hook" and then automate a workflow.

Example 1 - Send sold leads to my reporting database each time a lead is sold

You have your own reporting system which pulls all your cost data from your ad networks (like Facebook).  You need all revenue data (from LeadByte) so you can stitch together a P&L. You can create a Webhook to trigger each time a lead is sold to include (for example) the buyer, the adGroup, adName and how much the lead was sold for.

Example 2 - I need to turn off my Google ads when a buyer cap has been reached 

You may be running Google ads to generate leads for a specific client.  When the cap has been reached for the Buyer, you need to know so you can turn off your ads to avoid over spending.  In this instance, you can create a Webhook to Zapier to connect to your GA account and turn off your ads.

How to create a Webhook & the different types
To create a Webhook you need to navigate to Admin > Tech Hub > Webhooks as below animated image.  Any Webhooks that are listed in the Inactive tab will not fire.  Listed below are all the possible Webhooks with an explanation of each field.  With every Webhook you create you need to give it a reference; this is so you can identify the hook.  This reference is available in the payload.



Webhook types explained

We have the following Webhooks available for you to use -

 

Export Schedule Triggered

This Webhook will trigger when an export schedule runs or fails.  This is commonly used by advanced / technical LeadByte clients that log in their own CRM export schedule activity.

 

Lead Sold/Unsold

This Webhook will trigger when a lead is Sold, Unsold, Returned or Skipped against a Campaign.  This is commonly used by clients to signal to other apps that a lead has been sold.  For example, a client running Facebook ads may use a tool like AnyTrack to capture sold leads from LeadByte and then update their Facebook account with a purchase event to then further target sold leads.

 

Lead Valid/Invalid

This Webhook will trigger when a lead is deemed Valid AND/OR Invalid in a Campaign. It is commonly used by clients that need to store a log of their lead activity in their own reporting CRM.

 

SMS Link Clicked

This Webhook will trigger when an SMS link is clicked within a Responder Campaign.  This is commonly used by technical data driven clients that have their own reporting CRMs.

 

SMS Delivered/Undelivered

This Webhook will trigger when an SMS link is delivered or undelivered within a Responder Campaign.  This is commonly used by technical data driven clients that have their own reporting CRMs.

 

SMS Sent

This Webhook will trigger when an SMS is sent within a Responder Campaign.  This is commonly used by technical data driven clients that have their own reporting CRMs.

 

Campaign Alert

This Webhook is linked to Campaign alerts.  If you want to send a Webhook as well as an email when an alert is triggered, you need to create this type of Webhook.

 

Credit Threshold

This Webhook is also linked to Campaign alerts, however on the Buyer credit and Delivery credit threshold alerts specifically. Set your Delivery or Buyer credit nearly empty Alert up and then select your webhook to trigger alongside.

 

Feedback Added

This Webhook will trigger when feedback from a Buyer has been added to a lead.

 

Lead Quarantined

This Webhook will trigger when a lead has been Quarantined.

 

Credit Threshold

This Webhook will trigger when the credit (buyer or delivery) hits a certain threshold.

 

Rules on Webhook

If you'd like to stipulate criteria for when your webhook triggers, based on lead data then you're in luck.

Find our Webhook rules at the bottom of your webhook settings!

The below rule will only trigger for leads submitted by 1 specific supplier - 

 

Logs
Logs provide you with all the Webhook activity.  If you are not receiving any requests to your URL end-point (CRM, Zapier etc) you can use logs to see if the request was successful, what time it was sent and what the response was from the end-point.

FAQs
I want to see the payload before I go live, how can I see this?
You will need to use a service like https://webhook.site/ to capture the request so you can see the payload. 

 

Which version should I use?

We advise that you always use the recommended Webhook version.

 

Skipped webhook

You can fire a webhook on a skipped delivery event, however this must be ALL deliveries being skipped.

As a result, please ensure you use the "Enable for all" option for this setting to work.

 

Can I customise my webhook output?

Yes! On most webhooks you have the option to customise your output when using version 1.6 or above. Swap the Payload type to Custom and customise to your hearts content.

Can I test a Webhook?
Yes you can!  Within the Webhook at the bottom you have the option to "Test".  You will be given the option to push sample data to your endpoint.  The data you can send is subject the the Webhook type you use.  For example, if you use the "Lead Sold/Unsold" type, you have the option to send personal data as well as the Buyer or Delivery data.