{"id":374,"date":"2025-07-11T08:41:33","date_gmt":"2025-07-11T08:41:33","guid":{"rendered":"https:\/\/staging.knowledge-base.canapii.com\/\/index.php\/docs\/webhooks\/"},"modified":"2026-03-24T08:45:06","modified_gmt":"2026-03-24T08:45:06","password":"","slug":"webhooks","status":"publish","type":"docs","link":"https:\/\/staging.knowledge-base.canapii.com\/index.php\/docs\/webhooks\/","title":{"rendered":"Webhooks"},"content":{"rendered":"<p>If you&#8217;re unfamiliar with webhooks, think of them as tools for automated data delivery. Instead of manually checking for updates, admins are notified as soon as new data is available. You can use webhooks to send these notifications to third-party platforms like Slack, Microsoft Teams, or Cisco.<\/p>\n<p>To get started, first create a webhook in your chosen platform (e.g., Slack, Teams, etc.). Then, in your event console:<\/p>\n<ol>\n<li>\n<p>Go to the <strong>Tools<\/strong> tab and click\u00a0<strong>Integrations<\/strong><\/p>\n<\/li>\n<li>\n<p>Select <strong>Webhooks<\/strong><\/p>\n<\/li>\n<li>\n<p>Click <strong>Add<\/strong> to set up your webhook connection<\/p>\n<\/li>\n<\/ol>\n<p><img decoding=\"async\" class=\"article-image\" loading=\"lazy\" src=\"https:\/\/staging.knowledge-base.canapii.com\/\/wp-content\/uploads\/2026\/03\/image-png-Jul-10-2025-03-41-52-1830-PM.png\" style=\"max-width: 100%;height: auto\" \/><\/p>\n<hr \/>\n<h4 style=\"font-size: 1em;margin-top: 8px;margin-bottom: 4px\">Setting Up a Webhook<\/h4>\n<p style=\"text-align: left\">After clicking <strong>Add<\/strong>, you&#8217;ll be asked to configure several fields to define what kind of notifications you want to receive.<\/p>\n<p style=\"text-align: left\"><strong><br \/><span style=\"text-decoration: underline\">Event Types and Actions<\/span>:\u00a0<\/strong>Each webhook is associated with a specific event type and a corresponding action. The action determines when the webhook should activate based on activity.<\/p>\n<ul>\n<li>\n<p><strong>Attendee<\/strong><br \/>Notified when an attendee is <strong>created<\/strong>, <strong>updated<\/strong>, or <strong>deleted<\/strong>.<\/p>\n<\/li>\n<li>\n<p><strong>Meeting<\/strong><br \/>Notified when a meeting is <strong>booked<\/strong>, <strong>rescheduled<\/strong>, <strong>cancelled<\/strong>, or when an <strong>attendee\u2019s<\/strong> <strong>status is updated<\/strong>.<\/p>\n<\/li>\n<li>\n<p><strong>Session<\/strong><br \/>Notified when a session is <strong>created<\/strong>, <strong>booked<\/strong>, <strong>unbooked<\/strong>, <strong>joined<\/strong>, or <strong>watched<\/strong>.<\/p>\n<\/li>\n<li>\n<p><strong>Sponsor<\/strong><br \/>Notified on sponsor-related activities such as <strong>product creation<\/strong>, <strong>deletion<\/strong>, <strong>update<\/strong>, <strong>view<\/strong>, <strong>link click<\/strong>, <strong>asset download<\/strong>, <strong>chat<\/strong>, or when marked as <strong>interested<\/strong>.<\/p>\n<\/li>\n<li>\n<p><strong>Poll<\/strong><br \/>Notified when a poll is <strong>created<\/strong> or <strong>answered<\/strong>.<\/p>\n<\/li>\n<\/ul>\n<blockquote>\n<p>Example:<br \/>Event Type: <strong>Meeting<\/strong><br \/>Action: <strong>Book<\/strong><br \/>You&#8217;ll receive a notification whenever a meeting is booked.<\/p>\n<\/blockquote>\n<p style=\"text-align: left\"><strong><span style=\"text-decoration: underline\">Conte<\/span><span style=\"text-decoration: underline\">nt Type<\/span>: <\/strong><\/p>\n<ul>\n<li style=\"text-align: left\"><strong>application\/json <\/strong>\u2013 Sends data in JSON format<\/li>\n<li style=\"text-align: left\"><strong>application\/x-www-form-urlencoded <\/strong><span style=\"font-size: 1rem\">\u2013 Sends data in a single block in the HTTP message body<br \/><\/span><\/li>\n<\/ul>\n<p style=\"text-align: left\"><strong><span style=\"text-decoration: underline\">Status<\/span>: <\/strong><\/p>\n<ul>\n<li style=\"text-align: left\">Set the webhook to <strong>Active<\/strong> or <strong>Inactive<\/strong><\/li>\n<\/ul>\n<p style=\"text-align: left\"><strong><span style=\"text-decoration: underline\">Endpoint:<\/span>\u00a0<\/strong><\/p>\n<ul>\n<li style=\"text-align: left\">Enter the <strong>URL<\/strong> of the destination (e.g., Slack, Teams) where you want the webhook to send data.<\/li>\n<\/ul>\n<p><strong><span style=\"text-decoration: underline\">Headers<\/span>: <\/strong>When your webhook sends data, you can tack on extra pieces of information called headers. These help the receiving system know who\u2019s sending data, verify it\u2019s genuine, or pass along small bits of \u201cbehind-the-scenes\u201d info.<\/p>\n<ul>\n<li><strong>Key<\/strong>: The name of the header (label); Tells the server what kind of information this is<\/li>\n<li><strong>Value<\/strong>: The content that goes with that name; The actual data or token you want to send<\/li>\n<\/ul>\n<p><span style=\"text-decoration: underline\">How to use<\/span>:<\/p>\n<ol>\n<li>In <strong>Key<\/strong>, type the header name\n<ul>\n<li>Examples:\n<ul>\n<li><code>Authorization<\/code><\/li>\n<li><code>X-Client-ID<\/code><\/li>\n<li><code>X-Signature<\/code><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<li>In <strong>Value<\/strong>, type what you need to send\n<ul>\n<li>Examples:\n<ul>\n<li><code>Bearer abcd1234<\/code> (your secret token)<\/li>\n<li><code>67890<\/code> (your app\u2019s ID)<\/li>\n<li><code>f1e2d3c4b5<\/code> (a checksum or signature)<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<p>Now, every time the webhook runs, it will include those named pieces of information along with the data payload, ensuring the receiving system can recognize, authenticate, or process your request correctly.<\/p>\n<p style=\"text-align: left\"><strong><span style=\"text-decoration: underline\">Target Attendees:<\/span> <\/strong>(for Attendee Webhooks only)<\/p>\n<p>Apply filters to limit the webhook to specific attendees, like a particular ticket type, attendee type, language preference, etc.<\/p>\n<blockquote>\n<p>Example:<br \/>Event Type: <strong>Attendee<\/strong><br \/>Action: <strong>Create<\/strong><br \/>Target: <strong>Sponsor ticket type<\/strong><br \/>The webhook will notify you only when an attendee registers using the <strong>Sponsor<\/strong> ticket.<\/p>\n<\/blockquote>\n","protected":false},"excerpt":{"rendered":"<p>If you&#8217;re unfamiliar with webhooks, think of them as tools for automated data delivery. Instead of manually checking for updates, admins are notified as soon as new data is available. You can use webhooks to send these notifications to third-party platforms like Slack, Microsoft Teams, or Cisco. To get started, first create a webhook in [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"_crdt_document":"","footnotes":""},"doc_category":[56,18],"doc_tag":[],"class_list":["post-374","docs","type-docs","status-publish","hentry","doc_category-integration","doc_category-tools"],"year_month":"2026-04","word_count":453,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"name":"Canapii","author_nicename":"Canapii","author_url":"https:\/\/staging.knowledge-base.canapii.com\/index.php\/author\/administrator\/"},"doc_category_info":[{"term_name":"Integration","term_url":"https:\/\/staging.knowledge-base.canapii.com\/index.php\/docs-category\/integration\/"},{"term_name":"Tools","term_url":"https:\/\/staging.knowledge-base.canapii.com\/index.php\/docs-category\/tools\/"}],"doc_tag_info":[],"knowledge_base_info":[],"knowledge_base_slug":[],"_links":{"self":[{"href":"https:\/\/staging.knowledge-base.canapii.com\/index.php\/wp-json\/wp\/v2\/docs\/374","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/staging.knowledge-base.canapii.com\/index.php\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/staging.knowledge-base.canapii.com\/index.php\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/staging.knowledge-base.canapii.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/staging.knowledge-base.canapii.com\/index.php\/wp-json\/wp\/v2\/comments?post=374"}],"version-history":[{"count":1,"href":"https:\/\/staging.knowledge-base.canapii.com\/index.php\/wp-json\/wp\/v2\/docs\/374\/revisions"}],"predecessor-version":[{"id":909,"href":"https:\/\/staging.knowledge-base.canapii.com\/index.php\/wp-json\/wp\/v2\/docs\/374\/revisions\/909"}],"wp:attachment":[{"href":"https:\/\/staging.knowledge-base.canapii.com\/index.php\/wp-json\/wp\/v2\/media?parent=374"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/staging.knowledge-base.canapii.com\/index.php\/wp-json\/wp\/v2\/doc_category?post=374"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/staging.knowledge-base.canapii.com\/index.php\/wp-json\/wp\/v2\/doc_tag?post=374"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}