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 (webhook URL and authentication mode)
Webhook URL
To configure webhooks in the platform, you’ll need to generate a webhook URL from your external system. Some examples include:
Authentication mode
To configure webhooks in the platform, you’ll need to know your external systems authentication mode. Platform webhooks supports the following authentication modes:
| Authentication mechanism | Description |
|---|---|
| None | No authentication is selected. |
| Basic authentication |
A simple authentication method, where the client sends a username and password encoded as a Base64 string in the HTTP request's Authorization header. The server decodes these credentials and verifies them against its user database to grant or deny access. Enter a username and password. |
| API key |
Fill out the following fields:
Example:
|
| HMAC (Shared Secret) |
The Hash-based Message Authentication Code (HMAC) is a cryptographic technique that combines a hash function and a secret key. The API client does not need to send the actual secret, which serves as a protection against sniffing-related attacks. Fill out the following fields:
Example:
|
Create a webhook
To create a webhook:
- Navigate to organizational level.
- Under Manage, select Tools & Integrations.
- Choose the Webhooks option.
- Select Create webhook.
- Enter the webhook friendly name and URL.
- Choose the webhook authentication mode, and fill in the fields. For details, go to Authentication mechanism.
- 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 asset that you want event based notifications from. Learn more about platform events.
To connect a webhook to entities:
- Navigate to organizational level.
- Under Manage, select Tools & Integrations.
- Choose the Webhooks option.
- Find and select the webhook.
- From the three-dot action menu, choose Configure entities.
- Choose the projects, workspaces, and digital assets you want to send event based data from.
- Select Configure entities.
Comments
0 comments
Article is closed for comments.