AlterLabAPI Reference
Auto-generated
User Webhooks
API reference for user webhooks endpoints.
Auto-generated
This page was generated from the OpenAPI spec. Run
make generate-docs to refresh after spec changes.GET /api/v1/user-webhooks/{webhook_id}
GET
/api/v1/user-webhooks/{webhook_id}Get Webhook
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| webhook_id | string | Required | Webhook ID |
| X-Organization-Id | string | Optional | X-Organization-Id |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/user-webhooks/<webhook_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"webhook": "example",
"recent_deliveries": [],
"stats": {}
}PUT /api/v1/user-webhooks/{webhook_id}
PUT
/api/v1/user-webhooks/{webhook_id}Update Webhook
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| webhook_id | string | Required | Webhook ID |
| X-Organization-Id | string | Optional | X-Organization-Id |
| name | string | Optional | name |
| url | string | Optional | url |
| events | string[] | Optional | events |
| is_active | boolean | Optional | is_active |
Request Example
Bash
curl -X PUT https://api.alterlab.io/api/v1/user-webhooks/<webhook_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"id": "example",
"name": "example",
"url": "example",
"events": [],
"is_active": true,
"failure_count": 0
}DELETE /api/v1/user-webhooks/{webhook_id}
DELETE
/api/v1/user-webhooks/{webhook_id}Delete Webhook
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| webhook_id | string | Required | Webhook ID |
| X-Organization-Id | string | Optional | X-Organization-Id |
Request Example
Bash
curl -X DELETE https://api.alterlab.io/api/v1/user-webhooks/<webhook_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"status": "ok"
}