post/webhooks

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

urlstring uri required

HTTPS endpoint URL that will receive webhook POST payloads

eventsstring[] required

List of event types this webhook subscribes to

descriptionstring

Optional human-readable label for this webhook

activeboolean

Whether the webhook is active and receiving events

rateLimitPerMinuteinteger

Max deliveries per minute to this endpoint; omit for unlimited

maxAttemptsinteger

Max delivery attempts before dead-lettering (default 3)

Response

OK

idstring required

Unique identifier for the webhook

orgIdstring required

Organization that owns this webhook

urlstring uri required

HTTPS endpoint URL receiving webhook payloads

eventsstring[] required

Event types this webhook is subscribed to

activeboolean required

Whether the webhook is currently active

descriptionstring nullable required

Human-readable label for this webhook

consecutiveFailuresinteger required

Number of consecutive delivery failures across all events

disabledReasonstring nullable required

Reason the webhook was auto-disabled, null if manually disabled or active

disabledAtstring date-time nullable required

ISO 8601 timestamp when the webhook was auto-disabled

createdAtstring date-time required

ISO 8601 timestamp when the webhook was created

updatedAtstring date-time required

ISO 8601 timestamp when the webhook was last modified

authType'NONE' | 'BEARER' | 'BASIC' | 'CUSTOM_HEADER' required

Auth scheme the platform presents to your endpoint (never includes the secret)

authHeaderNamestring nullable required

Header name for CUSTOM_HEADER auth; null for other schemes

rateLimitPerMinuteinteger nullable required

Per-endpoint delivery rate cap in requests/minute; null = unlimited

maxAttemptsinteger nullable required

Per-webhook max delivery attempts; null = platform default (3)

secretstring required

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.