{"id":320,"date":"2021-04-21T09:27:02","date_gmt":"2021-04-21T09:27:02","guid":{"rendered":"https:\/\/utillz.com\/docs\/?page_id=320"},"modified":"2021-09-09T09:43:50","modified_gmt":"2021-09-09T09:43:50","slug":"webhooks","status":"publish","type":"page","link":"https:\/\/utillz.com\/docs\/notifications\/webhooks\/","title":{"rendered":"Webhooks"},"content":{"rendered":"<h3 id=\"what-is-a-webhook\">What is a webhook?<\/h3>\n<p>A webhook is an API concept that\u00e2\u20ac\u2122s growing in popularity. As more and more of what we do on the web can be described by events, webhooks are becoming even more applicable. They\u00e2\u20ac\u2122re incredibly useful and a resource-light way to implement event reactions.<\/p>\n<p>So, what exactly is a webhook? A webhook (also called a web callback or HTTP push API) is a way for an app to provide other applications with real-time information. A webhook delivers data to other applications as it happens, meaning you get data immediately.<\/p>\n<h3 id=\"why-should-i-use-webhooks\">Why should I use webhooks?<\/h3>\n<p>You can build your own process, send sms \/ emails \/ push notifications, collect information, build lists for later use and a lot more.<\/p>\n<h3 id=\"a-quick-video-about-webhooks-and-zapier\">A quick video about webhooks and Zapier<\/h3>\n<p><iframe title=\"YouTube video player\" src=\"https:\/\/www.youtube.com\/embed\/vn-qtbnEFa4\" width=\"100%\" height=\"357\" frameborder=\"0\" allowfullscreen=\"allowfullscreen\"><\/iframe><\/p>\n<h3 id=\"how-to-set-up-a-webhook\">How to set up a webhook?<\/h3>\n\r\n        <div class=\"warning warning-info has--tooltip\">\r\n                            <span class=\"__tooltip\">Info<\/span>\r\n                        <div class=\"__inner\">\r\n                <div class=\"__content\">\r\n                    <p>The example below was made with <a href=\"https:\/\/zapier.com\/\" target=\"_blank\" rel=\"noopener\">Zapier<\/a>, but you can use any other platform that allows you to handle webhooks. Some free alternative is <a href=\"https:\/\/www.integromat.com\/en\" target=\"_blank\" rel=\"noopener\">integromat.com<\/a><\/p>\r\n                <\/div>\r\n            <\/div>\r\n        <\/div>\r\n\r\n        \n<p><strong>Inside Zapier<\/strong><\/p>\n<p>1. Your first step is to create a \u00e2\u20ac\u02dcZap\u00e2\u20ac\u2122 in Zapier. A Zap is a blueprint for a task you want to do over and over. In words, a Zap looks like this: \u00e2\u20ac\u0153When I get a new thing in A, do this other thing in B.\u00e2\u20ac\u009d<\/p>\n<p><img class=\"alignnone wp-image-605 size-full\" src=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/My-Zaps-Zapier.png\" alt=\"\" width=\"1451\" height=\"720\" srcset=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/My-Zaps-Zapier.png 1451w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/My-Zaps-Zapier-300x149.png 300w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/My-Zaps-Zapier-1024x508.png 1024w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/My-Zaps-Zapier-768x381.png 768w\" sizes=\"(max-width: 1451px) 100vw, 1451px\" \/><\/p>\n<p>2. Choose Webhook \u00e2\u20ac\u201c On the left, you will see all the steps needed to complete the Zap.<\/p>\n<p><img class=\"alignnone wp-image-607 size-full\" src=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier.png\" alt=\"\" width=\"1148\" height=\"795\" srcset=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier.png 1148w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-300x208.png 300w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-1024x709.png 1024w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-768x532.png 768w\" sizes=\"(max-width: 1148px) 100vw, 1148px\" \/><\/p>\n<p>3. Choose trigger \u00e2\u20ac\u201c On the \u00e2\u20ac\u02dcSelect webhooks by Zapier trigger\u00e2\u20ac\u2122 screen, choose \u00e2\u20ac\u02dcCatch hook\u00e2\u20ac\u2122 and press \u00e2\u20ac\u02dcSave + Continue\u00e2\u20ac\u2122<\/p>\n<p><img class=\"alignnone wp-image-610 size-full\" src=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-catch.png\" alt=\"\" width=\"1132\" height=\"625\" srcset=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-catch.png 1132w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-catch-300x166.png 300w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-catch-1024x565.png 1024w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-catch-768x424.png 768w\" sizes=\"(max-width: 1132px) 100vw, 1132px\" \/><\/p>\n<p>4. Set up trigger \u00e2\u20ac\u201c Here you can copy the webhook URL, paste it into your site back-end webhook field and click the button <strong>Trigger Webhook<\/strong>. This will send a test call, so you can catch the requires fields.<br \/>\n<img class=\"alignnone wp-image-621 size-full\" src=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-set-up-trigger-copy.png\" alt=\"\" width=\"1137\" height=\"881\" srcset=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-set-up-trigger-copy.png 1137w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-set-up-trigger-copy-300x232.png 300w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-set-up-trigger-copy-1024x793.png 1024w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-set-up-trigger-copy-768x595.png 768w\" sizes=\"(max-width: 1137px) 100vw, 1137px\" \/><br \/>\n5. Test this step \u00e2\u20ac\u201c Copy the Zapier webhook to your clipboard<br \/>\n<img class=\"alignnone size-full wp-image-622\" src=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-test.png\" alt=\"\" width=\"1138\" height=\"875\" srcset=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-test.png 1138w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-test-300x231.png 300w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-test-1024x787.png 1024w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Name-your-zap-Zapier-test-768x591.png 768w\" sizes=\"(max-width: 1138px) 100vw, 1138px\" \/><\/p>\n<p><strong>Inside your configuration<\/strong><\/p>\n<p>1. Go to your website, and inside the notification configuration, edit the notification you want to get integrated to Zapier. Enable the webhook using the checkbox.<\/p>\n<p>2. Enter the hook you copied from Zapier<\/p>\n<p>3. Save the changes, and click the button <strong>Trigger webhook<\/strong>. This sends the Webhook to Zapier, to confirm the hook we created.<\/p>\n<p><img class=\"alignnone wp-image-665 size-full\" src=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/05\/Settings-\u2039-Booking-\u2014-WordPress-1.png\" alt=\"\" width=\"1051\" height=\"660\" \/><\/p>\n<p>4. Back in Zapier, under Test trigger <i class=\"material-icon-arrow_right_alt __arrow\"><\/i> Requests, click the Load more button to refresh the requests and you should see new entry.<\/p>\n<p><img class=\"alignnone size-full wp-image-347\" src=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/04\/request.png\" alt=\"\" width=\"1041\" height=\"857\" srcset=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/04\/request.png 1041w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/04\/request-300x247.png 300w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/04\/request-1024x843.png 1024w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/04\/request-768x632.png 768w\" sizes=\"(max-width: 1041px) 100vw, 1041px\" \/><\/p>\n<p>5. Click the new request and you should see all the parameter that we sent to the webhook.<\/p>\n<p><img class=\"alignnone size-full wp-image-346\" src=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/04\/params.png\" alt=\"\" width=\"1033\" height=\"818\" srcset=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/04\/params.png 1033w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/04\/params-300x238.png 300w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/04\/params-1024x811.png 1024w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/04\/params-768x608.png 768w\" sizes=\"(max-width: 1033px) 100vw, 1033px\" \/><\/p>\n<p>6. Click Continue<\/p>\n<p><strong>Create the Action that zapier performs<\/strong><\/p>\n<p>Now you need to create the action that follows our trigger.<\/p>\n<p>You can now choose one of the 1,000+ apps in Zapier. It could be a system for sending sms messages, email application or anything else.<\/p>\n<p><img class=\"alignnone size-full wp-image-345\" src=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/04\/action.png\" alt=\"\" width=\"1145\" height=\"812\" srcset=\"https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/04\/action.png 1145w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/04\/action-300x213.png 300w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/04\/action-1024x726.png 1024w, https:\/\/utillz.com\/docs\/wp-content\/uploads\/2021\/04\/action-768x545.png 768w\" sizes=\"(max-width: 1145px) 100vw, 1145px\" \/><\/p>\n<h3 id=\"what-pre-defined-fields-are-being-sent-to-the-webhook-url\">What pre-defined fields are being sent to the webhook url.<\/h3>\n<p><strong>Receiver<\/strong><\/p>\n<ul>\n<li><code>user_id<\/code><\/li>\n<li><code>user_first_name<\/code><\/li>\n<li><code>user_last_name<\/code><\/li>\n<li><code>user_display_name<\/code><\/li>\n<li><code>user_email<\/code><\/li>\n<li><code>user_billing_email<\/code><\/li>\n<li><code>user_billing_phone<\/code><\/li>\n<li><code>user_billing_country<\/code><\/li>\n<li><code>user_billing_city<\/code><\/li>\n<li><code>user_billing_postcode<\/code><\/li>\n<\/ul>\n<p><strong>Sender<\/strong><\/p>\n<ul>\n<li><code>from_user_id<\/code><\/li>\n<li><code>from_user_first_name<\/code><\/li>\n<li><code>from_user_last_name<\/code><\/li>\n<li><code>from_user_display_name<\/code><\/li>\n<li><code>from_user_email<\/code><\/li>\n<li><code>from_user_billing_phone<\/code><\/li>\n<\/ul>\n<p><strong>Listing<\/strong><\/p>\n<ul>\n<li><code>listing_id<\/code><\/li>\n<li><code>listing_name<\/code><\/li>\n<li><code>listing_url<\/code><\/li>\n<\/ul>\n<h3 id=\"webhook-custom-fields\">Webhook custom fields<\/h3>\n<p><strong>Advanced users only<\/strong>: you can add additional custom meta fields using a simple comma-separated string.<\/p>\n<p>Example: <strong>webhook_param_name:listing_meta_key<\/strong>.<\/p>\n<p><strong>webhook_param_name<\/strong> stands for the parameter name that will be sent to the webhook and <strong>listing_meta_key<\/strong> stands for the post meta key, that you want to extract from the listing and send. The post meta value will be collected from the listing post type.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>What is a webhook? A webhook is an API concept that\u00e2\u20ac\u2122s growing in popularity. As more and more of what we do on the web &#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":316,"menu_order":51,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"_links":{"self":[{"href":"https:\/\/utillz.com\/docs\/wp-json\/wp\/v2\/pages\/320"}],"collection":[{"href":"https:\/\/utillz.com\/docs\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/utillz.com\/docs\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/utillz.com\/docs\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/utillz.com\/docs\/wp-json\/wp\/v2\/comments?post=320"}],"version-history":[{"count":0,"href":"https:\/\/utillz.com\/docs\/wp-json\/wp\/v2\/pages\/320\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/utillz.com\/docs\/wp-json\/wp\/v2\/pages\/316"}],"wp:attachment":[{"href":"https:\/\/utillz.com\/docs\/wp-json\/wp\/v2\/media?parent=320"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}