Reference
Webhooks
Subscriptions to the workspace's events, and the log of every delivery.
Subscriptions to the workspace's events, and the log of every delivery.
| Method | Path | What it does |
|---|---|---|
GET | /webhooks | List webhook subscriptions |
POST | /webhooks | Create a webhook subscription (returns plaintext secret) |
DELETE | /webhooks/{id} | Delete a webhook subscription |
GET | /webhooks/{id} | Get a webhook subscription |
PUT | /webhooks/{id} | Update a webhook subscription |
GET | /webhooks/{id}/deliveries | List webhook delivery attempts |
GET /webhooks
List webhook subscriptions
curl https://api.vitrinadev.com/api/v1/webhooks \
-H "Authorization: Bearer $VITRINA_KEY"Answers: 200 · 400 · 401 · 403 · 404 · 409 · 429
POST /webhooks
Create a webhook subscription (returns plaintext secret)
Body
| Field | Type | Required | Constraints |
|---|---|---|---|
url | string | yes | uri, máx. 2048 |
events | * \ | ai_agent.publish \ | ai_agent_graph.publish \ |
description | string | null | — | máx. 500 |
curl -X POST https://api.vitrinadev.com/api/v1/webhooks \
-H "Authorization: Bearer $VITRINA_KEY" \
-H "Content-Type: application/json" \
-d '{ … }'Answers: 201 · 400 · 401 · 403 · 404 · 409 · 429
DELETE /webhooks/{id}
Delete a webhook subscription
| Parameter | In | Type | Required | Constraints |
|---|---|---|---|---|
id | path | uuid | yes |
curl -X DELETE https://api.vitrinadev.com/api/v1/webhooks/<id> \
-H "Authorization: Bearer $VITRINA_KEY"Answers: 204 · 400 · 401 · 403 · 404 · 409 · 429
GET /webhooks/{id}
Get a webhook subscription
| Parameter | In | Type | Required | Constraints |
|---|---|---|---|---|
id | path | uuid | yes |
curl https://api.vitrinadev.com/api/v1/webhooks/<id> \
-H "Authorization: Bearer $VITRINA_KEY"Answers: 200 · 400 · 401 · 403 · 404 · 409 · 429
PUT /webhooks/{id}
Update a webhook subscription
| Parameter | In | Type | Required | Constraints |
|---|---|---|---|---|
id | path | uuid | yes |
Body
| Field | Type | Required | Constraints |
|---|---|---|---|
url | string | — | uri, máx. 2048 |
events | * \ | ai_agent.publish \ | ai_agent_graph.publish \ |
enabled | boolean | — | |
description | string | null | — | máx. 500 |
curl -X PUT https://api.vitrinadev.com/api/v1/webhooks/<id> \
-H "Authorization: Bearer $VITRINA_KEY" \
-H "Content-Type: application/json" \
-d '{ … }'Answers: 200 · 400 · 401 · 403 · 404 · 409 · 429
GET /webhooks/{id}/deliveries
List webhook delivery attempts
| Parameter | In | Type | Required | Constraints |
|---|---|---|---|---|
id | path | uuid | yes | |
limit | query | integer | no | ≥ 1, ≤ 200, por defecto 50 |
offset | query | integer | null | no | ≥ 0, por defecto 0 |
curl https://api.vitrinadev.com/api/v1/webhooks/<id>/deliveries \
-H "Authorization: Bearer $VITRINA_KEY"Answers: 200 · 400 · 401 · 403 · 404 · 409 · 429