Introduction

Webhooks allows you to listen to real-time events happening across your Heyoo workspace. With webhooks, you can build custom integrations with Heyoo, such as:

• Triggering a Zap on Zapier when a new campaign is created in Heyoo
• Sending click events in real-time to your analytics platform when a campaign is clicked
• Get a Slack notification when a post published event occurs
• Building gamified referral programs and tracking campaign shares in your CRM

In this guide, we’ll show you how to configure webhooks for your Heyoo workspace and a list of available events you can listen to.

​

Creating a webhook

To create a webhook for your Heyoo workspace, you’ll need to follow these steps: Navigate to the Webhooks settings page in your Heyoo workspace dashboard under Settings > Webhooks. Click on Create Webhook to create a new webhook. Fill in the required fields in the webhook creation form:

1. Name: Give your webhook a name that helps you identify it.
2. URL: Enter the URL of the endpoint where you want to send the webhook. We recommend using webhook.site to test your webhook.
3. Signing secret: This is an auto-generated secret key that you can use to verify the authenticity of the webhook in your application. Learn more about verifying webhook requests.
4. Events: Select the events you want to listen to. You can select multiple events. Refer to the Event Types section to see the list of available events.

Finally, click on Create webhook to create the webhook.

​

Viewing webhook event logs

We also provide you with a webhook event logs page where you can view all the webhook events that have been sent to your webhook endpoint in real-time. To view the webhook event logs, select the webhook from the Webhooks settings page and click on the Webhook Logs tab. Here, you’ll see a list of all the webhook events that have been sent to your webhook endpoint. You can also select on a specific event, which will open up a sheet with more details about the event.

​

Sending test events

You can send test events to your webhook URL to ensure that it’s working correctly. To do this:

​

Retry Behaviour

If your webhook endpoint does not respond with a success status code (2XX), we retry the request to ensure every message will be delivered. You can see all the retry attempts in your webhook event logs. Webhooks are retried until they are successfully delivered – with an exponential backoff to avoid overwhelming your webhook endpoint (also known as the “thundering herd problem”). The delay is capped at 24 hours from the 5th retry attempt onwards.

​

Temporary Disablement

If a webhook endpoint consistently fails, it will be automatically disabled after a series of failed attempts. Notifications will be sent to the Workspace owners at the following intervals:

• After 5, 10, and 15 consecutive failed attempts.
• On the 20th consecutive failed attempt, the webhook will be disabled.

This mechanism ensures that non-responsive endpoints do not continue to receive retry attempts indefinitely, maintaining system efficiency and preventing unnecessary load on both the sender and receiver. You can re-enable a disabled webhook by clicking on the Enable webhook button in the webhook details page.