All Collections
How to use Webhooks? 🕸🪝
How to use Webhooks? 🕸🪝

Use webhooks to get important campaign events sent straight to a compatible web app or URL as soon as it’s detected.

Updated over a week ago

What are webhooks?

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.

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!

How to set up webhooks?

For the purpose of this demonstration, and to check your own test URLs, you can use to collect test submissions. Here are the steps to set up your webhooks:

  1. Go to your Instantly settings, then go to Integrations. You'll find webhooks in the list

  2. Click on 'Add Webhook' to make a new connection.

  3. Now, enter a destination URL. This is where we will make HTTP POST requests.

  4. Select the campaign you want to send event notifications from, for this webhook.

  5. Select the event type from within the campaign to send notifications.

  6. Click on '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.

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.

Here’s a sample payload (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

Additional information sent (based on the type of webhook and availability of data):

  1. lead_email

  2. firstName

  3. lastName

  4. companyName

  5. website

  6. phone

  7. step [sequence step number]

  8. email_account [your email account that contacted the lead]

Did this answer your question?