Knowledge base

Webhooks

Webhooks allow you to subscribe to real-time notifications about various events that occur in VhtLtd.

Listen for events on your VhtLtd account so your integration can automatically trigger reactions. You can create a webhook directly from your account.

For example, an HTTP POST callback is sent to your provided URL with a payload about the sent email. It allows you to get the most recent updates without constantly polling the API.

Note:

Webhooks 2.0 have launched! This makes webhook payloads lighter for better, faster performance. Learn more about the new webhooks.

Add a webhook to your domain

To create a webhook, follow these steps:

1. Go to the Domains page.

2. Click Manage for the domain you wish to add webhooks to.

3. Scroll down to Webhooks.

4. Click Add webhook.

5. Complete the form by entering the endpoint URL you wish the information to be sent to and your webhook name.

6. Select the events you would like to listen to, or click on receive all events if you wish to listen to them all: Delivery, Soft bounce, Hard bounce, Open, Click, Unsubscribe, Spam complaint.

Note:

For any webhooks you create, 2.0 (Recommended) will be selected by default as the webhook version. You can opt to use 1.0 (Legacy) if you prefer.

7. Click on Save webhook and you’re done!

add a webhook for transactional emails

Once you have saved your webhook, you can copy your secret webhook key to your receiving app. You can find this on the webhook management page.

You can also pause the webhook by clicking on Edit and then on the Status toggle, moving it from Enabled to Disabled.

Webhook details

How to test a webhook

To test your webhook:

1. Choose the webhook you wish to test and click Manage.

2. Under Events, click Test webhook.

3. Select a test event from the dropdown menu to send to the webhook’s endpoint to test your integration.

About webhook attempts

You can consult all webhook attempts that have been made in the last 7 days in the Webhook attempts section of your webhook description page.

Webhook attempts log

When your webhook receives a response other than a 2xx code from your endpoint URL, or if the endpoint doesn’t respond within 3 seconds, it will show up as a failed attempt in the log section of your webhook. If it receives a 2xx, then it will show as a success.

If a webhook call fails, VhtLtd will retry the call a couple of times, waiting 10 seconds between the first and second attempt and 100 seconds between the second and the third attempt to avoid hammering the application you want the information sent to.

Need more info?

Please feel free to contact us at [email protected] and a member of our support team will gladly assist you.