Configure webhooks

Who can use this feature?

• Organization administrators
• Available for Accelerate and Enterprise.

Stay informed by integrating platform notifications into your everyday tools and processes using webhooks. Webhooks is a callback function that allows you to send event based data to an external end point. In other words, it’s a configuration that automatically triggers event notifications outside of the platform. For example, sending a scan completed notification to Slack.

On this page:

• Requirements
• Create a webhook
• Configure a webhook to entities

Requirements

Webhook URL

To configure webhooks in the platform, you’ll need to generate a webhook URL from your external system. Some examples include:

• Slack
• Microsoft Teams
• Zapier

Authentication mechanism

To configure webhooks in the platform, you’ll need to know your external systems authentication mode. Platform webhooks supports the following authentication mechanisms:

• None
• Basic authentication (username and password)
• API key

Create a webhook

To create a webhook:

1. Select the Control hub and choose Tools and integrations.
2. Select Webhooks.
3. Select Create webhook.
4. Enter the webhook friendly name and URL.
5. Choose the authentication mode.
6. Select Create webhook.

Configure a webhook to entities

Select your source of event based data by configuring your webhook to platform entities. A platform entity is the workspace, project, or digital property that you want event based notifications from. Learn more about platform events.

To connect a webhook to entities:

1. Select the control hub and choose Tools and integrations.
2. Select Webhooks.
3. Find the webhook and select the three-dot action menu.
4. Select Configure entities.
5. Choose the projects, workspaces, and websites/apps you want to send event based data from.
6. Select Configure entities.