Webhooks
    • 06 Jun 2024
    • 2 Minutes to read
    • Contributors
    • Dark
      Light
    • PDF

    Webhooks

    • Dark
      Light
    • PDF

    Article summary

    Webhooks Module PNG.png
    Webhooks

    Overview

    Webhook subscriptions enable CommBox clients to receive notifications when certain selected events occur within the system and send those notifications to a desired Webhooks events listener within the client’s organization. For example, when a new customer is identified in CommBox, the information is reported and recorded in the CRM.

    Click here to learn more about the webhooks in our Developer Center.

    Setting up a New Subscription

    Follow these steps to create a new subscription:

    1. At the Settings page, select the Webhooks module (in the Integrations section), and click the Add New Subscription button at the top.
      image.png

    2. In the New Subscription form, enter the Details as follows:
      a. Enter a meaningful name - a unique identifier name not previously used.
      b. Select the Entity – the type of events subscriptions you want to subscribe to, such as Object, User, Tags, etc.
      new trigger1.png
      c. Select the specific Trigger Event and its components (where applicable).
      Note: When selecting OnNewActivity Event types, the selected types will be greyed out when selecting additional triggers. If you want to add communication channels, add them at the original trigger settings.
      new activity.png
      d. Add additional triggers from this group as needed.
      e. Checking the Include Complete Data (Optional) will send the entire payload when the webhook gets triggered. (Not recommended)
      f. Click Next to continue.

    3. Select the Webhook type (REST protocol or SOAP protocol). Once selected, the method and format will be filled in automatically.
      Enter a secured Webhooks URL (Starting with https://) that will receive the notifications from CommBox.
      Note:
      a. When choosing the SOAP protocol, you have the option to add the SOAP message parameters.
      b. For Isolated customers only: If we already have a Certificate from your organization, you may select to add this security measure for sending your webhooks. Contact your CS for more information.
      webhook type - rest - new.png

    4. Authentication is an optional step to enable the subscription to pass the security credentials of your organization.
      Select between the Basic and OAuth 2.0 authentication.
      For basic authentication, enter a username and password.
      image.png
      For OAuth 2.0 authentication, select and enter the desired type (access token, client credentials, or password credentials).

    • For Access Token, enter the Header Prefix (example: Bearer) and Access Token (key)
      image.png

    • For Client Credentials, enter the following:
      a. The URL where the information will go.
      b. The Scope’s name (as it appears in your system) that will limit the access to the information. Learn more at this link: https://cloud.google.com/apigee/docs/api-platform/security/oauth/working-scopes
      c. Client ID
      d. Client Secret
      image.png

    • For Password Credentials, all of the items mentioned above.
      image.png

    1. Select the number of retries (0-5) in case the webhook connection fails.
      The default is set to 3 retries with 5-minute intervals in between.
      retry settings.png

    2. Click Create Webhook to complete the subscription process.

    Managing Existing Webhook Subscriptions

    • To suspend a webhook subscription, deactivate the relevant webhook by toggling it Off.

    disable webhook.png

    • To permanently delete the webhook, hover over the 3-dot menu at the end of the line and select Delete.
    Webhook management.png

    • To edit information within an existing webhook, click on the listed item to open the subscription form. When you finish editing, click Update Webhook at the last step.
    update webhook.png


    Was this article helpful?