Webhooks allow you to automatically sync data between Heyloyalty and other systems. This guide will help you set up a webhook so that changes to your list are recorded in real time. You will likely need assistance from your IT department to complete this setup.
Images will be added to this guide later.
Set up a Webhook in Heyloyalty
What is a webhook?
A webhook acts as a link between two systems. When a change occurs in one system—such as an update to member data—the webhook sends a message to the other system. This ensures that your systems remain synchronized in real time when, for example, a contact is added or removed.
Webhook events
The following events can trigger a webhook in Heyloyalty:
- Update Contact Information
- Unsubscribe from this contact
- Register Contact
- Update Password
- Click (when a contact clicks on an email)
- Open (when a contact opens an email)
- Soft bounce (when an email does not reach the contact’s inbox due to an error, or because their inbox is full)
- Hard bounce (when an email address does not exist—for example, if it has been deleted)
Create a webhook
You create a webhook on your list. Go to the ” Lists ” menu item >. From the list where you want to create the webhook, click the three dots (•••) >. Then select ” Edit List.” Here, select the ” Webhooks” tab. Next, choose to create a webhook and fill in the settings.
You can decide for yourself which of the events listed above should trigger your webhook. To enable an event, check the box next to it.
Example of webhook output
You can see an example of webhook output here. This provides a clear picture of the data that is sent to your external system.