Skip to main content
POST

Overview

Register a callback URL to receive signed event payloads whenever AIOKA events occur. Each delivery includes a X-AIOKA-Signature: sha256=<hex> header you can use to verify authenticity. Tier: Basic 🔒 Limit: 5 webhooks per API key Delivery: HMAC-SHA256 signed via X-AIOKA-Signature: sha256=<hex> header Retries: Up to 3 attempts with exponential backoff (5s, 25s, 125s) Auto-disable: After 10 consecutive failures, the webhook is deactivated

Supported Events

Request

string
required
The HTTPS URL to deliver payloads to. Must start with https://.
array
required
List of event types to subscribe to. Must contain at least 1 and at most 5 items. Duplicates are rejected.

Response

string
UUID of the webhook subscription.
string
The registered HTTPS callback URL.
array
List of subscribed event types.
boolean
Whether the webhook is currently active.
string
ISO 8601 creation timestamp.
string
Shown only once. The HMAC signing secret. Store it securely — it cannot be retrieved again.
integer
Number of consecutive delivery failures since last success.

Verifying Signatures

On receipt, verify every delivery using the secret shown at registration: