Developers

Webhooks

Get notified the moment your data changes.

Scratchboard sends a signed HTTPS POST to your endpoint when records change, approvals resolve or workflows run. Use it to sync other systems, trigger jobs or post alerts.

How it works

Set up once in the app, then receive events as they happen.

  1. 1

    Add an endpoint

    In the app, open Event Webhooks in the admin area and add your HTTPS URL.

  2. 2

    Choose events

    Keep “All events” on, or pick event types and the entities they apply to.

  3. 3

    Verify and process

    Check the signature with your endpoint's signing secret, then return any 2xx status.

18 event types

Named resource.action. Most can be filtered by entity.

Records

record.createdrecord.updatedrecord.deletedrecord.bulk-createdrecord.bulk-updatedrecord.bulk-deleted

Approvals

approval.createdapproval.resolved

Workflows

workflow.executedworkflow.failedworkflow.cancelled

Actions

action.executed

Notes & notifications

note.creatednotification.created

Schema

entity.changed

Vector search

vector.index.createdvector.index.reindexedvector.index.deleted

Payload and signature

A versioned JSON envelope, signed with HMAC-SHA256.

Each request carries three headers: X-Webhook-Id, X-Webhook-Timestamp and X-Webhook-Signature. The signature is an HMAC-SHA256 of the timestamp, a dot, and the raw request body, keyed with your endpoint's signing secret (it starts with whsec_).

Example payload
{
  "id": "6f1c…",
  "type": "record.updated",
  "apiVersion": "2026-10-01",
  "created": "2026-10-25T09:30:00.000Z",
  "data": {
    "entityName": "leads",
    "recordId": "…",
    "userId": "…",
    "changedFields": ["status"]
  }
}
Verify a request (Node.js)
import crypto from "node:crypto";

// header: X-Webhook-Signature: t=<unix seconds>,v1=<hex>
function verify(rawBody, header, secret) {
  const parts = Object.fromEntries(header.split(",").map((p) => p.split("=")));
  const expected = crypto
    .createHmac("sha256", secret)          // secret = your whsec_... value
    .update(`${parts.t}.${rawBody}`)
    .digest("hex");
  const fresh = Math.abs(Date.now() / 1000 - Number(parts.t)) < 300;
  return fresh && expected.length === parts.v1.length &&
    crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(parts.v1));
}

Verify against the raw body, before any JSON parsing. Rejecting timestamps older than 5 minutes protects against replayed requests.

Retries and reliability

Any non-2xx response or timeout is retried automatically.

AttemptSent
#1Immediately
#25 minutes later
#330 minutes later
#42 hours later
#524 hours later

Filter by event and entity

Subscribe to all events, or pick event types and limit them to specific entities, such as only Invoices.

Delivery log

Each endpoint shows its deliveries with status and response code, and lets you send a test event.

Retry and replay

Failed deliveries retry on their own. You can also retry a delivery by hand from the log.

Safe auto-disable

A failing endpoint is paused only after 10 failed deliveries in a row and 72 hours without a success. Events are held for 7 days so you can replay them.

Questions

Straight answers for developers.

How many webhook endpoints can I have?
2 on Starter, 25 on Pro and a custom number on Enterprise. All plans start with a 7-day free trial.
Are events delivered in order, exactly once?
Treat delivery as at least once and not strictly ordered: a retry can arrive after a newer event. Use the event id to ignore duplicates and the created timestamp to order them.
Can I ignore changes that came from a sync?
Yes. Changes made by a data integration include an origin field in data, so your receiver can skip echoes of its own sync.
Can workflows call my systems too?
Yes. Besides event webhooks, a workflow step can call an API connection (an outbound HTTP request you set up in the app), for example after an approval is granted.

Where to next

Keep exploring, or start building.

Start receiving events

Start a 7-day free trial, add an endpoint under Event Webhooks, and send a test event.