Send leads to your CRM

You can have each new lead posted as JSON to your own endpoint, and get a daily email with the number of new leads. Both are set on the Leads page.

Before you start

• You have an endpoint on a public https:// address that accepts a POST.
• You have a signing secret of at least 16 characters. Keep it on your server.
• To save these settings, you need the Owner, Admin or Manager permission.

For agencies

Choose the client under Advertiser first. Each client has its own settings.

Steps

1. Open Leads and scroll to Send leads to your CRM.
2. Enter your Webhook URL and Signing secret.
3. Tick Post each new lead.
4. To get a daily email, tick Email me a daily count.
5. Select Save.
6. Select Send a test lead. The page tells you what your endpoint answered.

A test lead is marked "test": true and nothing is stored.

What happens next

Each new lead is posted shortly after it arrives. Your endpoint should answer with a 2xx status within 10 seconds. Redirects aren't followed.

A failed post is tried up to 5 times in all, over about two and a half hours. After that the lead shows as failed in the Delivery column, and you can still get it from the list or CSV.

The daily email goes to your advertiser contact address, with the number of new leads. Test leads aren't counted.

Check the signature

Every request is signed so you can check that it came from MailAdx. Open How to check the signature on the page for the header name, the method and a code sample. Reject requests older than five minutes.

What each post carries

Field	Contents
event	lead.created
id, createdAt	The lead's id and time
kind	LEAD, SUBSCRIBE or RSVP
email, fields	What the reader sent
rsvp	The chosen time, on RSVP leads
doubleOptInRequired	true on subscribers. Send your own confirmation first
campaign, publisherId	Where the lead came from
consent	The consent text, privacy URL and time
test	true on test data

If something goes wrong

• "The webhook must be an https:// URL". Plain http isn't accepted.
• "Add the webhook URL first". Enter it before you tick Post each new lead.
• "Use a signing secret of at least 16 characters". Use a longer secret.
• "Set a signing secret so you can verify our requests". A webhook can't be switched on without one.
• "Your endpoint answered 500". Your endpoint received the test and failed. Check its logs.
• "Your endpoint did not answer". Check the URL is public and answers within 10 seconds.