Webhooks
Subscribe to row mutation events for each API with Svix-backed outbound webhooks.
Paid plans can send outbound webhooks when rows change through the public API. Delivery, retries, and endpoint management are powered by Svix.
Availability
Webhooks require the webhooks plan feature (Starter, Pro, and Business). Free accounts see an upgrade prompt in the console.
Configure endpoints per API from the console: open an API → Webhooks. The portal is embedded in the console for managing endpoints, delivery logs, and retries.
Events
| Event | Trigger |
|---|---|
row.created | POST /v1/:apiId |
row.updated | PATCH /v1/:apiId/:rowNumber |
row.replaced | PUT /v1/:apiId/:rowNumber |
row.deleted | DELETE /v1/:apiId/:rowNumber |
Reads and calculate calls do not emit webhooks.
Payload
Every message includes a JSON body shaped like:
{
"type": "row.created",
"apiId": "550e8400-e29b-41d4-a716-446655440000",
"sheet": "Customers",
"rowNumber": 12,
"data": { "name": "Ada", "active": true },
"occurredAt": "2026-09-14T06:41:00.000Z"
}sheet is the $sheet query value when provided, otherwise null (the adapter default / first sheet). For deletes, data is null.
Verifying signatures
Svix signs each delivery. Use the signing secret from the App Portal endpoint settings and the official Svix verification libraries. See the Svix consuming webhooks guide.
Notes
- One Svix application is created per BlazeSheets API.
- Emitting never blocks or fails the public API response; delivery runs asynchronously.
- Deleting an API best-effort removes its Svix application.