Request
- Base URL: https://api.useanima.sh/v1
- URL: https://api.useanima.sh/v1/webhooks
- Auth: one of:
- HTTP bearer
- API key in header X-API-Key
Request body
HTTPS endpoint URL that will receive webhook POST payloads
List of event types this webhook subscribes to
Optional human-readable label for this webhook
Whether the webhook is active and receiving events
Max deliveries per minute to this endpoint; omit for unlimited
Max delivery attempts before dead-lettering (default 3)
Response
OK
Unique identifier for the webhook
Organization that owns this webhook
HTTPS endpoint URL receiving webhook payloads
Event types this webhook is subscribed to
Whether the webhook is currently active
Human-readable label for this webhook
Number of consecutive delivery failures across all events
Reason the webhook was auto-disabled, null if manually disabled or active
ISO 8601 timestamp when the webhook was auto-disabled
ISO 8601 timestamp when the webhook was created
ISO 8601 timestamp when the webhook was last modified
Auth scheme the platform presents to your endpoint (never includes the secret)
Header name for CUSTOM_HEADER auth; null for other schemes
Per-endpoint delivery rate cap in requests/minute; null = unlimited
Per-webhook max delivery attempts; null = platform default (3)
The signing secret, returned ONLY at creation time. Store it now — read endpoints (get/list) never return it again. Use it to verify the X-Anima-Signature header on every delivery. If lost, rotate via POST /webhooks/{id}/rotate-secret.
Changes
No recorded changes to this operation across all 1 revision of this API.