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.
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.
Note: For your IT department or IT staff member to set up a webhook, they need to know the format we use for our messages. We always send messages in JSON format. Read more about JSON here.
Webhook events
The following events can trigger a webhook in Heyloyalty:
- New contact (email, phone)
- New contact (Webpush)
- Update contact
- Unsubscribe contact
- Spam complaint (when a contact marks an email as spam)
- Click (when a contact clicks in an email)
- Opening (when a contact opens an email)
- Hard bounces (when an email address does not exist—for example, if it has been deleted)
- Anonymized contact
- Sent (when a contact receives an email)
Create a webhook
You create a webhook on your list. Go to the Lists menu item. For the list where you want to create the webhook, click the three dots (•••). Then select Edit list. Here, select the Webhooks tab. Next, click 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.