Manage Webhooks

Webhooks allow you to create rules in CA Agile Central that send information to an external server when the rule triggers. Only subscription administrators can manage webhooks.

Webhooks are usually triggered by an event, such as pushing code to a repository or a comment being posted to a blog. When the event occurs, the source site makes an HTTP request to the URI configured for the webhook. Users can configure them to cause events on one site to invoke behavior on another.

Some useful applications of webhooks include:

  • Receive an update when a single artifact changes
  • Receive updates when any artifact changes in your subscription

The Webhooks page displays all webhooks that exist in a subscription. Subscription administrators can view which webhooks are being used as well as who is using them. This ensures the security of a subscription’s data.

For information on creating and editing webhooks, see the API documentation.

On the Webhooks page, subscription administrators can view, enable, disable, and delete webhooks for the subscription and workspace. Each webhook listed has the following details:

  • Name
  • Application link
  • Creator of the webhook
  • Revision date of the webhook
    • Date settings are based on the date and time format you set in your profile
  • Active (On or Off)
    • When the Active toggle is On, the webhook will fire

To delete a webhook, click the gear icon next to the webhook and select Delete. Click Confirm on the confirmation pop-up. This will permanently delete the webhook.

You can disable all webhooks from the subscription editor, which serves as a master switch for all webhooks. Even if a webhook is listed as active on the Webhooks page, it will be inactive if webhooks are disabled from the subscription editor. Webhooks are enabled by default.

If all webhooks have been disabled from the subscription editor, the following banner displays on the Webhooks page with a link to change the setting.

To enable or disable all webhooks:

  1. Click the Subscription menu.
  2. From the Actions drop-down menu, click Edit Subscription.
  3. In the Admin Capabilities section, check or uncheck the Webhooks Enabled field.
  4. Click Save.

    Caution: Disabling all webhooks in the subscription will also disable any Flowdock – CA Agile Central integration.

Feedback

Need more help? The CA Agile Central Community is your one-stop shop for self-service and support. To submit feedback or cases to CA Agile Central Support, find answers, and collaborate with others, please join us in the CA Agile Central Community.