Skip to main content

Outbound Webhook Creation

This article explains how to create Outbound Webhooks to send event notification from Agility to external systems.

Overview​

Outbound webhooks can be configured via the user interface, as described below.

Creating a new Outbound Webhook Subscription via the UI​

Administration of webhooks requires System Admin access. The Webhook administration page can be accessed by clicking the hamburger menu Hamburger icon > Webhooks in the Extensions section.

Outbound Webhook Creation

  1. On the Webhooks administration page, click the Add button at the top right.

  2. In the Subscription tab of the slideout window, there are 3 required fields:

    • URL - the url to which event information will be posted

    • From - the asset type ( Backlog Item, etc.) to be monitored

    • Event Type - the event type that will trigger the webhook

      • Event Types include Asset Created, and Asset Changed.
      • If you want to monitor for changes to only certain attributes of an asset, you can select one or more Trigger Attributes.

  4. Note that you can configure more than one Trigger Event in a single webhook subscription.

  5. Authorization Header and Secret fields allow you to optionally configure your subscription with additional security (see the webhooks API documentation).

Authorization Header and Secret fields can be set, but once set, they cannot be read either by the API or in the User Interface.

  1. Webhook ID and Description Information fields are optional.
  2. Save the subscription configuration. It will be added to the list of webhooks, and enabled by default.

Webhooks can also be configured via the API.

Webhook