# Webhooks {#webhooks}



## Page Overview {#page-overview}



### What the page is for {#what-the-page-is-for}
The Webhooks Management page allows you to create and manage webhook subscriptions to receive real-time notifications about events in your workspace. You can monitor delivery status, test webhooks, and manage secrets.


### When a user would use it {#when-a-user-would-use-it}
- When you want to receive real-time notifications about events
- When you need to create a new webhook subscription
- When you want to enable or disable existing webhooks
- When you need to rotate webhook secrets
- When you want to monitor webhook delivery status
- When you need to retry failed deliveries
- When you want to test webhook functionality


## How to Access This Page {#how-to-access-this-page}



### Navigation path from the main app {#navigation-path-from-the-main-app}
1. Log in to the application
2. From the main dashboard, use the sidebar navigation to click on "Webhooks"
3. Or, directly navigate to `/webhooks` in your browser


### Permissions or prerequisites {#permissions-or-prerequisites}
- You must be logged in to access this page
- You need appropriate permissions to manage webhooks


## Page Layout {#page-layout}



### Header / title {#header--title}
- **Title**: "Webhook Management"
- **Subtitle**: "Manage webhook subscriptions and monitor delivery status"


### Stats cards {#stats-cards}
Four cards showing key metrics:
1. **Total Deliveries**: Total number of webhook deliveries
2. **Successful (24h)**: Number of successful deliveries in the last 24 hours (green)
3. **Failed (24h)**: Number of failed deliveries in the last 24 hours (red)
4. **Active Subscriptions**: Number of currently active webhook subscriptions (blue)


### Main tabs {#main-tabs}
Three tabs to switch between views:
1. **Subscriptions**: Manage your webhook subscriptions
2. **Deliveries**: Monitor webhook delivery status
3. **Testing**: Test webhook functionality


## Subscriptions Tab {#subscriptions-tab}



### Add Subscription button {#add-subscription-button}
- Button to create a new webhook subscription
- Located at the top right of the tab


### Subscription cards {#subscription-cards}
Each subscription is displayed as a card with:
- **Name**: Webhook name
- **Status badge**: Active (green) or Inactive (gray)
- **URL**: The webhook endpoint URL
- **Event types**: Badges showing which events trigger this webhook
- **Created date**: When the subscription was created
- **Actions**:
  - Toggle switch to enable/disable the webhook
  - Rotate Secret button (refresh icon)
  - Delete button (trash icon)
- **View Deliveries button**: Takes you to the Deliveries tab filtered by this subscription


## Deliveries Tab {#deliveries-tab}



### Refresh button {#refresh-button}
- Refreshes the delivery list
- Located at the top right of the tab


### Deliveries table {#deliveries-table}
Shows all webhook deliveries with details like:
- Delivery ID
- Webhook subscription
- Event type
- Status (Success/Failed)
- Timestamp
- Response
- Retry button for failed deliveries


## Testing Tab {#testing-tab}



### Webhook Test Panel {#webhook-test-panel}
Allows you to send test events to your webhooks to verify they're working correctly.


## Step-by-Step Tasks {#step-by-step-tasks}



### Creating a Webhook Subscription {#creating-a-webhook-subscription}
1. Go to the Subscriptions tab
2. Click the "Add Subscription" button
3. Fill in the webhook details:
   a. Enter a name (required)
   b. Enter the webhook URL (required)
   c. Select which event types to subscribe to
4. Save the subscription
5. The new subscription will appear in the list


### Enabling/Disabling a Webhook {#enablingdisabling-a-webhook}
1. Find the webhook subscription in the list
2. Toggle the switch to enable or disable it
3. The status badge will update immediately


### Rotating a Webhook Secret {#rotating-a-webhook-secret}
1. Find the webhook subscription
2. Click the Rotate Secret button (refresh icon)
3. A dialog will open showing your new secret
4. **Important**: Copy the secret immediately - you won't be able to see it again!
5. Click "Copy to Clipboard" to copy it
6. Click "Close" when done


### Viewing Deliveries for a Subscription {#viewing-deliveries-for-a-subscription}
1. Find the webhook subscription
2. Click the "View Deliveries" button on its card
3. You'll be taken to the Deliveries tab filtered to show only deliveries for this subscription


### Refreshing Deliveries {#refreshing-deliveries}
1. Go to the Deliveries tab
2. Click the "Refresh" button
3. The delivery list will update


### Retrying a Failed Delivery {#retrying-a-failed-delivery}
1. Go to the Deliveries tab
2. Find a failed delivery
3. Click the Retry button
4. The delivery will be retried


### Deleting a Webhook Subscription {#deleting-a-webhook-subscription}
1. Find the webhook subscription you want to delete
2. Click the Delete button (trash icon)
3. Confirm the deletion in the dialog
4. The subscription will be removed


### Testing Webhooks {#testing-webhooks}
1. Go to the Testing tab
2. Use the Webhook Test Panel to send test events
3. Verify that your webhook receives the events correctly


## Field & Button Reference {#field--button-reference}


| Field/Button | What it does | When to use it |
|--------------|--------------|----------------|
| Add Subscription | Creates a new webhook | When you want to set up a new webhook |
| Toggle switch | Enables/disables a webhook | When you want to pause or resume a webhook |
| Rotate Secret | Generates a new secret | When you need to update the webhook secret for security |
| Delete | Removes a webhook | When you no longer need a webhook |
| View Deliveries | Shows deliveries for a subscription | When you want to check delivery status for a specific webhook |
| Refresh | Updates delivery list | When you want to see the latest delivery status |
| Retry | Retries a failed delivery | When a delivery failed and you want to try again |


## Tips & Notes {#tips--notes}


- **Copy secrets immediately**: When you rotate a secret, copy it right away - you won't be able to see it again!
- **Monitor failed deliveries**: Check the Deliveries tab regularly for failed deliveries and retry them
- **Test first**: Use the Testing tab to verify your webhook works before relying on it
- **Use specific event types**: Only subscribe to the event types you need to reduce unnecessary traffic
- **Keep secrets secure**: Treat webhook secrets like passwords - don't share them or commit them to version control