{"id":3494,"date":"2024-12-10T04:16:41","date_gmt":"2024-12-10T04:16:41","guid":{"rendered":"https:\/\/team.innoquad.in\/wordpress-team\/doce-demo\/wordpress\/?p=3494"},"modified":"2024-12-12T12:14:56","modified_gmt":"2024-12-12T12:14:56","slug":"create-webhooks","status":"publish","type":"post","link":"https:\/\/documentation.iqonic.design\/wpbookit\/create-webhooks\/","title":{"rendered":"Create Webhooks"},"content":{"rendered":"
\n
\"\"<\/figure>\n\n\n\n

On the Webhooks page, click the New <\/strong>button to open the webhook creation form.<\/p>\n\n\n\n

Fill Out the Webhook Details<\/strong><\/h2>\n\n\n\n

Provide the necessary information for the webhook configuration:<\/p>\n\n\n\n

Webhook Name<\/strong><\/h4>\n\n\n\n
    \n
  • Enter a unique name for your webhook. This name helps you identify its purpose (e.g., “New Booking Notification”).<\/li>\n<\/ul>\n\n\n\n

    Module Name<\/strong><\/h4>\n\n\n\n
      \n
    • Select the module related to the webhook. For example, choose “Bookings”<\/strong> if the webhook is triggered by booking events or “Customer”<\/strong> if the webhook is triggered by customer events.\"\"<\/li>\n<\/ul>\n\n\n\n

      Event Name<\/strong><\/h4>\n\n\n\n
        \n
      • Pick the specific event that will trigger the webhook. Examples include “New Booking,” “Edit Bookings,” or “Delete Booking.”\"\"<\/li>\n<\/ul>\n\n\n\n

        Status<\/strong><\/h4>\n\n\n\n
          \n
        • Set the webhook’s status to Active<\/strong> to enable it. You can set it to Inactive<\/strong> if you want to temporarily disable it.<\/li>\n<\/ul>\n\n\n\n

          Template Dynamic Keys List<\/strong><\/h4>\n\n\n\n
            \n
          • Select an event option it generate dynamic keys automictically for the selected module and event. These keys can be used to customize the webhook’s payload.<\/li>\n<\/ul>\n\n\n\n

            HTTP Request<\/h4>\n\n\n\n
              \n
            • The HTTP Method<\/strong> field offers multiple options to define how data is transmitted to the external server. You can choose from the following methods based on your integration needs:\"\"<\/li>\n<\/ul>\n\n\n\n
                \n
              • HTTP POST<\/strong>: Used for sending data securely to an external server (commonly used for creating or updating resources).<\/li>\n\n\n\n
              • HTTP GET<\/strong>: Ideal for retrieving data from an external server.<\/li>\n\n\n\n
              • HTTP DELETE<\/strong>: Used to request the deletion of resources on an external server.<\/li>\n\n\n\n
              • HTTP PUT<\/strong>: Used for updating or replacing resources on an external server.<\/li>\n<\/ul>\n\n\n\n

                Webhook URL<\/strong><\/h4>\n\n\n\n
                  \n
                • Enter the URL of the external application or service where the webhook data should be sent.<\/li>\n<\/ul>\n\n\n\n

                  Add Headers (Optional)<\/strong>\"\"<\/h4>\n\n\n\n
                    \n
                  • Click the Add Header<\/strong> button to include additional information in the webhook request, such as authentication tokens or custom fields.<\/li>\n\n\n\n
                  • Provide the header name and value as required.<\/li>\n<\/ul>\n\n\n\n

                    Select Content Type<\/strong>\"\"<\/h4>\n\n\n\n
                      \n
                    • Choose the content type for the data to be sent with the webhook request. The available options are:<\/li>\n<\/ul>\n\n\n\n
                        \n
                      • Form Data<\/strong>: Suitable for sending data in the standard application\/x-www-form-urlencoded<\/code> format.<\/li>\n<\/ul>\n\n\n\n
                          \n
                        • JSON Data<\/strong>: Ideal for sending data in a structured application\/json<\/code> format, commonly used in modern API integrations.<\/li>\n<\/ul>\n\n\n\n

                          Form Data Section<\/strong><\/h4>\n\n\n\n
                            \n
                          • The Form Data<\/strong> section allows you to define custom key-value pairs that will be sent as part of the webhook request. Here’s how it works:\"\"<\/li>\n<\/ul>\n\n\n\n
                              \n
                            • Add Form Data<\/strong>:\n
                                \n
                              • Use the “Add Form Data” button to include additional key-value pairs in the request payload.<\/li>\n\n\n\n
                              • This feature is useful for customizing the data being transmitted to external systems.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                              • Key Field<\/strong>:\n
                                  \n
                                • Enter the name of the parameter expected by the receiving system.<\/li>\n\n\n\n
                                • This represents the identifier for the data being sent.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                                • Value Field<\/strong>:\n
                                    \n
                                  • Assign a dynamic value to the key using predefined placeholders (e.g., {{placeholder_name}}<\/code>).<\/li>\n\n\n\n
                                  • Copy the dynamic key form Template Dynamic Keys List<\/strong> and past in Value field of form data.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                                  • Delete Field<\/strong>:\n
                                      \n
                                    • Use the delete icon to remove unnecessary key-value pairs from the form data.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                                    • Similarly, you can add dynamic keys when using the JSON Content Type. This allows you to configure and send data in a structured JSON format with dynamic placeholders that are automatically populated during the webhook execution.<\/li>\n<\/ul>\n<\/div>","protected":false},"excerpt":{"rendered":"

                                      On the Webhooks page, click the New button to open the webhook creation form. Fill Out the Webhook Details Provide the necessary information for the webhook configuration: Webhook Name Module Name Event Name Status Template Dynamic Keys List HTTP Request Webhook URL Add Headers (Optional) Select Content Type Form Data Section<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":3358,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[13],"tags":[],"class_list":["post-3494","post","type-post","status-publish","format-standard","hentry","category-wpbookit-webhook-addon"],"featured_image_src":null,"author_info":{"display_name":"Iqonic Design","author_link":"https:\/\/documentation.iqonic.design\/wpbookit\/author\/dwd3f32kd2r2rf23wf4df\/"},"children":[],"_links":{"self":[{"href":"https:\/\/documentation.iqonic.design\/wpbookit\/wp-json\/wp\/v2\/posts\/3494","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/documentation.iqonic.design\/wpbookit\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/documentation.iqonic.design\/wpbookit\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/documentation.iqonic.design\/wpbookit\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/documentation.iqonic.design\/wpbookit\/wp-json\/wp\/v2\/comments?post=3494"}],"version-history":[{"count":1,"href":"https:\/\/documentation.iqonic.design\/wpbookit\/wp-json\/wp\/v2\/posts\/3494\/revisions"}],"predecessor-version":[{"id":3982,"href":"https:\/\/documentation.iqonic.design\/wpbookit\/wp-json\/wp\/v2\/posts\/3494\/revisions\/3982"}],"up":[{"embeddable":true,"href":"https:\/\/documentation.iqonic.design\/wpbookit\/wp-json\/wp\/v2\/posts\/3358"}],"wp:attachment":[{"href":"https:\/\/documentation.iqonic.design\/wpbookit\/wp-json\/wp\/v2\/media?parent=3494"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/documentation.iqonic.design\/wpbookit\/wp-json\/wp\/v2\/categories?post=3494"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/documentation.iqonic.design\/wpbookit\/wp-json\/wp\/v2\/tags?post=3494"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}