WebHooks are notifications sent over the Web and triggered whenever a certain event occurs.
In this case, the event is a new campaign event in Instantly. As soon as an event occurs (such as emails being opened or replies arriving), a notification with the response data is immediately sent to the webhook URL which is set in the configuration panel.
Available events
Available events
Email sent
Email bounced
Email opened
Email link clicked
Reply received
Lead unsubscribed
Campaign completed
Email account error
Lead is marked as interested
Lead is marked as not interested
Lead is marked as neutral
Lead status changed to Meeting booked
Lead status changed to Meeting complete/Not closed
Lead status changed to Close
Lead status changed to Out of office
Lead status changed to Wrong person
Other custom labels you created
Instantly webhook notifications are sent via a POST request, while the request body (with response data) is in JSON format. Instantly users who understand how to handle webhooks will be able to take advantage of this advanced feature. Our team cannot troubleshoot your code or provide step-by-step development instructions.
Set up your WebHooks
For the purpose of this demonstration, and to check your own test URLS, you can use this link to collect test submission.
Here are the steps to set up your webhooks.
Go to your Instantly settings.
Navigate to Integrations tab. You'll find webhooks in the list.
Click Add Webhook to make a new connection.
Enter a destination URL. This is where we will make HTTP POST requests.
Select the campaign you want to send event notifications from for this webhook.
Select the event type from within the campaign to send notifications for.
Click Add Webhook after all three fields are done, and you should be able to see it added to the list where you can add new webhooks or delete existing ones.
Note: Once Webhook has been created and added, there is no way to edit it. You need to delete it and create a new webhook with the correct URL.
Sample Payload
Here is an sample payload that is sent via POST.
{
"timestamp": new Date().toISOString(), // time of event
"event_type": event_type // example: [email_opened, email_sent, etc.]
"campaign_name": "your_campaign_name",
"workspace": "your_workspace_id",
"campaign_id": "your_campaign_id
}
Here is an additional information sent (based on the type of webhook and availability of data).
lead_email
firstName
lastName
companyName
website
phone
step [sequence step number]
email_account [your email account that contacted the lead]