{"id":5172,"date":"2026-03-09T09:21:59","date_gmt":"2026-03-09T08:21:59","guid":{"rendered":"https:\/\/guides.heyloyalty.com\/help\/webhook-2\/"},"modified":"2026-07-15T15:43:56","modified_gmt":"2026-07-15T13:43:56","slug":"webhook-2","status":"publish","type":"ht_kb","link":"https:\/\/guides.heyloyalty.com\/en\/help\/webhook-2\/","title":{"rendered":"Webhook"},"content":{"rendered":"<div class=\"wp-block-post-date\"><time datetime=\"2026-03-09T09:21:59+01:00\">9. March 2026<\/time><\/div>\n<p class=\"wp-block-paragraph\">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.  <\/p>\n\n<p class=\"wp-block-paragraph\">Images will be added to this guide later.<\/p>\n\n<h2 class=\"wp-block-heading\">Set up a Webhook in Heyloyalty<\/h2>\n\n<h3 class=\"wp-block-heading\">What is a webhook?<\/h3>\n\n<p class=\"wp-block-paragraph\">A webhook acts as a link between two systems. When a change occurs in one system\u2014such as an update to member data\u2014the 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.  <\/p>\n\n<p class=\"wp-block-ht-blocks-messages wp-block-hb-message wp-block-hb-message--withicon is-style-info\"><strong>Note:<\/strong> In order for your IT department or IT staff member to set up a webhook, they must know the format we use for our messages. We always send messages in &nbsp;<strong>JSON format<\/strong>.&nbsp;<a href=\"http:\/\/www.ecma-international.org\/publications\/files\/ECMA-ST\/ECMA-404.pdf\">Read more about JSON here.<\/a><\/p>\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n<h3 class=\"wp-block-heading\">Webhook events<\/h3>\n\n<p class=\"wp-block-paragraph\">The following events can trigger a webhook in Heyloyalty:<\/p>\n\n<ul class=\"wp-block-list\">\n<li><strong>Update Contact Information<\/strong><\/li>\n\n\n\n<li><strong>Unsubscribe from this contact<\/strong><\/li>\n\n\n\n<li><strong>Register Contact<\/strong><\/li>\n\n\n\n<li><strong>Update Password<\/strong><\/li>\n\n\n\n<li><strong>Click<\/strong> (when a contact clicks on an email)<\/li>\n\n\n\n<li><strong>Open<\/strong> (when a contact opens an email)<\/li>\n\n\n\n<li><strong>Soft bounce<\/strong> (when an email does not reach the contact&#8217;s inbox due to an error, or because their inbox is full)<\/li>\n\n\n\n<li><strong>Hard bounce<\/strong> (when an email address does not exist\u2014for example, if it has been deleted)<\/li>\n<\/ul>\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n<h3 class=\"wp-block-heading\">Create a webhook<\/h3>\n\n<p class=\"wp-block-paragraph\">You create a webhook on your list. Go to the &#8221; <strong>Lists<\/strong> &#8221; menu item <strong> &gt;<\/strong>. From the list where you want to create the webhook, click<strong> the three dots (\u2022\u2022\u2022)<\/strong> &gt;. Then select &#8221; <strong>Edit List<\/strong>.&#8221; Here, select the &#8221; <strong>Webhooks<\/strong>&#8221; tab. Next, choose to create a webhook and fill in the settings.   <\/p>\n\n<p class=\"wp-block-paragraph\">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. <\/p>\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n<h4 class=\"wp-block-heading\">Example of webhook output<\/h4>\n\n<p class=\"wp-block-paragraph\">You can see an example of <a href=\"https:\/\/guides.heyloyalty.com\/en\/help\/webhook-output\/\" target=\"_blank\" rel=\"noreferrer noopener\">webhook output here<\/a>. This provides a clear picture of the data that is sent to your external system. <\/p>\n","protected":false},"excerpt":{"rendered":"<p>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&#8230;<\/p>\n","protected":false},"author":7,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":{"footnotes":""},"ht-kb-category":[79,73],"ht-kb-tag":[],"class_list":["post-5172","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-data-og-tracking","ht_kb_category-integrations-and-api"],"_links":{"self":[{"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/ht-kb\/5172","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/users\/7"}],"replies":[{"embeddable":true,"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/comments?post=5172"}],"version-history":[{"count":1,"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/ht-kb\/5172\/revisions"}],"predecessor-version":[{"id":5173,"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/ht-kb\/5172\/revisions\/5173"}],"wp:attachment":[{"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/media?parent=5172"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/ht-kb-category?post=5172"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/guides.heyloyalty.com\/en\/wp-json\/wp\/v2\/ht-kb-tag?post=5172"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}