Skip to main content

Managing webhooks

You can use webhooks to share information from your Applications with third parties. Webhooks are always triggered as an effect.

Learn more about webhooks in our Developer docs.

Feature access

Only admins and Application admins have access to this feature.

Listing webhooks​

You can list all the webhooks in your account. Draft webhooks also appear in this list.

To list all the webhooks in your account:

  1. On the leftmost menu, click Account.
  2. Click Tools > Webhooks.

The Webhooks page contains the following information:

ColumnDescription
NameName, description, and state of the webhook.
VerbMethod of the HTTP request: POST, PUT, GET, DELETE or PATCH.
ApplicationsThe Applications in which the webhook is available.
CopyClickable icon that allows you to copy the webhook.
note

If you are an Application admin, the list does not contain webhooks connected to individual Applications unless you have access to at least one of those Applications.

Creating a webhook​

To create a webhook:

  1. In the lower-left corner, click Account > Tools > Webhooks.

  2. To create a webhook from scratch, click Create Webhook. Alternatively, click a draft webhook to continue creating it.

  3. In Name, type a name for the webhook.

    tip

    To save the webhook as a draft, type the name and click Save Draft. You can continue creating it later.

  4. (Optional) In Description, type a description for the webhook.

  5. In the Connected Applications section, select the Applications where you want the webhook to be available.
    By default, it is available for use in all Applications.

  6. In the Request details section, do the following:

    • In Verb, select the type of request (DELETE, GET, PATCH, POST, or PUT).
    • In URL, enter the URL of the receiving service. Only HTTP and HTTPS protocols are supported.

  7. In the Credentials section, select the credentials to use for authentication.

  8. In the Headers section, add any request headers required by the receiving service as key-value pairs.

    To add a header, click Add Header. You can add more than one header. To remove one, click .

    note
    • Some servers may not accept the request without an appropriate Header value.
      • By default, "Content-Type": "application/json" is included. You cannot edit or remove it.
    • In the URL and Header fields, you can use custom attributes the same way as in the payload. For example:
      1. Create a custom attribute with the Application entity called url.
      2. In your Applications, define the attribute value: https://webhook.site/application1.
      3. In the URL field of your webhook, reference the attribute: ${$Application.Attributes.url}.

  9. (Optional) For PATCH, POST, and PUT, in the Parameters section, define the parameters in your webhook that can be populated with a value when a rule is successfully evaluated. This allows you to share data from the Rule Engine with the webhook recipient.

    • In Type, select the data type of the parameter.
    • In Name, type the name of the parameter.
    • (Optional) In Description, add a description for the parameter you're defining.

    You can add more than one parameter. To add a parameter, click Add Parameter. To remove one, click .

  10. (Optional) In the Payload section, enter and format the payload in JSON format. See Defining the webhook payload.

    tip

    You can reference custom attributes as shown below:

    {
       "attributePayload": "${$Profile.Attributes.Name}",
       "parameterPayload": "${$ParameterName}"
    }

  11. (Optional) In the Preview section, review the payload that is sent in the webhook.

  12. Validate the URL and headers by sending a test request. To do this, in the Test section, click Test Webhook.

  13. Click Create Webhook.

The webhook is created, and the list of webhooks is displayed.

Editing a webhook​

To edit a webhook:

  1. On the leftmost menu, click Account.
  2. Click Tools > Webhooks.
  3. Click the name of a webhook to open it.
  4. Make the required changes and click Save.
note

You can only view a webhook and cannot edit it if one of the following applies:

  • The webhook is referenced in a campaign.
  • You are an Application admin, and the webhook is connected to all Applications.
  • You are an Application admin, and the webhook is connected to at least one Application for which you do not have access rights.

In these cases, all input fields are disabled.

Copying a webhook​

You can copy all the parameters and request details of a webhook to a new webhook. There are no dependencies between the original and the copy.

To copy a webhook:

  1. On the leftmost menu, click Account.

  2. Click Tools > Webhooks.

  3. Next to the webhook you want to copy, click .

    tip

    To copy a webhook that you're editing, in the Copy section, click Copy Webhook.

  4. Enter the basic properties of the copy, and click Copy Webhook.

Deleting a webhook​

To delete a webhook:

  1. On the leftmost menu, click Account.
  2. Click Tools > Webhooks.
  3. Click the name of a webhook to open it.
  4. In the Delete section, click Delete Webhook.
  5. In the confirmation window, click Delete Webhook.
note

You cannot delete a webhook if one of the following applies:

  • The webhook is referenced in a campaign.
  • You are an Application admin, and the webhook is connected to all Applications.
  • You are an Application admin, and the webhook is connected to at least one Application for which you do not have access rights.