Omni Webhooks

Overview

Register, list, test, and remove webhook endpoints. Configure event subscriptions (request.completed, request.failed, quota.exceeded, etc.) and manage delivery retries.

Authentication

All requests require a valid Bearer token or session cookie. Obtain a token via POST /api/auth/login or configure REQUIRE_API_KEY=false for local development.

Endpoints

GET /api/webhooks

GET webhooks

curl https://localhost:20128/api/webhooks \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"

POST /api/webhooks

POST webhooks

curl -X POST https://localhost:20128/api/webhooks \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

GET /api/webhooks/{id}

GET webhooks ›

curl https://localhost:20128/api/webhooks/{id} \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"

PUT /api/webhooks/{id}

PUT webhooks ›

curl -X PUT https://localhost:20128/api/webhooks/{id} \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

DELETE /api/webhooks/{id}

DELETE webhooks ›

curl -X DELETE https://localhost:20128/api/webhooks/{id} \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"

GET /api/webhooks/{id}/deliveries

GET webhooks › › deliveries

curl https://localhost:20128/api/webhooks/{id}/deliveries \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"

POST /api/webhooks/{id}/test

POST webhooks › › test

curl -X POST https://localhost:20128/api/webhooks/{id}/test \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

POST /api/webhooks/validate-url

POST webhooks › validate url

curl -X POST https://localhost:20128/api/webhooks/validate-url \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Payloads

See the full OpenAPI specification at GET /api/openapi/spec or docs/openapi.yaml for detailed request/response schemas.