Webhooks API
Subscribe your own endpoint to Velaro events.
Base URL: https://api-admin-us-east.velaro.com/api/v1. Send your API key as Authorization: Bearer vlk_.... Create keys under Settings > API Keys; each key carries only the scopes you grant it.
Queues one signed test delivery to a webhook subscription of the key's site.
POST /api/v1/webhooks/{id}/test
Required scope: write:webhooks
| Parameter | In | Type | Notes |
|---|---|---|---|
| id | path | integer (int64) | required |
Delete webhook
DELETE /api/v1/webhooks/{id}
Required scope: write:webhooks
| Parameter | In | Type | Notes |
|---|---|---|---|
| id | path | integer (int64) | required |
Catalog of webhook event types a subscription can listen to, plus the signature scheme.
GET /api/v1/webhooks/events
Required scope: read:webhooks
List webhooks
GET /api/v1/webhooks
Required scope: read:webhooks
Create webhook
POST /api/v1/webhooks
Required scope: write:webhooks
Request body: JSON CreateWebhookRequest
Common responses: 401 for a missing or invalid key, 403 when the key lacks the scope, 429 when the rate limit is reached.
Was this article helpful?