Configuring Webhook Integration
Overview
The Webhook integration allows administrators to configure outbound webhooks that send event or system data to external endpoints. Admins can define the webhook URL, choose an authentication method, manage credentials, control activation status, review delivery logs, and restrict access through team-based permissions to ensure secure and reliable data exchange.
Step-by-Step Approach
1. Create a New Webhook Integration
- On the General Dashboard, go to Integrations.
- Click + Integration.
- Select Webhook from the list of available integration types.
- Enter a meaningful name for the integration.
- Save the integration.
2. Enter or Edit the Webhook URL
- Open the Webhook integration.
- Locate the URL field.
- Enter or edit the required webhook endpoint URL.
- Save your changes.
3. Select the Authentication Type
- Open the Webhook integration.
- Locate the Authentication Type dropdown.
- Select one of the following options:
- None – No authentication is applied.
- Basic – Uses username and password authentication.
- OAuth – Uses token-based OAuth authentication.
- Save your selection.
4. Enter Credentials for Authentication Type: Basic
- Select Basic as the Authentication Type.
- Enter or edit the Username.
- Enter or edit the Password.
- Save your changes.
5. Enter Credentials for Authentication Type: OAuth
- Select OAuth as the Authentication Type.
- Enter or edit the Token.
- Enter or edit the Client ID.
- Enter or edit the Client Secret.
- Save your changes.
6. Activate or Deactivate the Webhook Integration
- Open the Webhook integration.
- Use the Activate / Deactivate toggle.
- Activated: Webhook requests are sent to the configured URL.
- Deactivated: No webhook requests are triggered.
- Confirm the status change.
7. Access the Logs Listing
- Open the Webhook integration.
- Navigate to the Logs tab to view webhook request status, timestamps, and responses.
8. Access the Teams Listing
- Open the Webhook integration.
- Navigate to the Teams tab.
9. Select Teams from the Select Teams Pop-Up
- Click Select Teams.
- In the Select Teams pop-up, browse or search for teams.
- Select one or more teams.
- Click Select to confirm.
- The selected teams appear in the Teams listing.
10. Remove Teams from the Listing
- In the Teams listing, locate the team you want to remove.
- Click the More Options (⋮) icon next to the team name.
- Select Remove teams.
11. Remove the Webhook Integration
- Open the Webhook integration.
- Click Delete or Remove Integration.
- Confirm the deletion.
Once configured, the Webhook integration provides a flexible and secure way to send data to external systems, with full control over authentication, activation, logging, and team access.