跳到主要内容
Docs/Api Reference/Webhooks

Webhooks API

Outbound webhooks let Anvil push events to your URL.

Endpoints

MethodPathDescription
GET`/api/v1/webhooks`List
POST`/api/v1/webhooks`Create
PATCH`/api/v1/webhooks/:id`Update
DELETE`/api/v1/webhooks/:id`Delete
POST`/api/v1/webhooks/:id/test`Send a test payload

Events

See [Webhook Setup](/docs/integrations/webhooks) for the full event catalog.

Signing

Each request carries Anvil-Signature: t=<ts>,v1=<hmac-sha256>. See the integrations webhooks doc for verification code.

Every response uses the standard envelope:

{
  "success": true,
  "data": { /* resource or array */ },
  "meta": { "total": 100, "cursor": "...", "hasMore": true },
  "error": { "code": "ERROR_CODE", "message": "Human readable" }
}

error is omitted on success; meta is omitted when not paginating.

Rate Limits

Subject to the standard 200 req/min/tenant authenticated limit. See [Rate Limits](/docs/api-reference/rate-limits) for full details and the per-endpoint overrides.

← Back to Docs