Sign in

v1

latestOpenAPI 3.1.22026-08-0611530152.3 KB
Webhooks

Create webhook

Creates a webhook. A POST request will be made for each message in the queue to this endpoint. If the endpoint returns a HTTP status code in the 200 range the message will be acknowledged and removed from the queue, otherwise retried.

Signature Verification: When a signing_secret is configured, webhook requests will include headers for signature verification:

  • webhook-id: Unique message identifier
  • webhook-timestamp: Unix timestamp (seconds)
  • webhook-signature: HMAC-SHA256 signature (format: v1,<base64>)

The signature is computed over {webhook-id}.{webhook-timestamp}.{body}.

Key Rotation: Multiple secrets can be specified (space-separated) for zero-downtime key rotation. When multiple secrets are configured, signatures are generated for all of them, allowing consumers to verify with any key during the transition period.

post/webhooks

Response

Webhook created successfully

idinteger

Webhook ID

namestring nullable

Label for the webhook

webhook_uristring

Webhook endpoint URL

queuestring

Queue name

last_statusstring nullable

Last webhook status

concurrencyinteger

Max simultaneous outstanding requests

timeoutinteger

The request timeout for webhook_uri

signing_secretstring nullable

Secret key(s) for HMAC-SHA256 signature verification. When configured, webhook requests include webhook-id, webhook-timestamp, and webhook-signature headers. Multiple secrets can be specified (space-separated) for key rotation.

vhoststring

Virtual host name

Example response

{
  "id": 1,
  "name": "my-webhook",
  "webhook_uri": "http://www.example.com/endpoint",
  "queue": "push-queue",
  "concurrency": 10,
  "timeout": 30,
  "signing_secret": "my-secret-key-123",
  "vhost": "hptqevnp"
}