Webhook reference

Every event your webhooks can receive, what each one carries, and how to check that a delivery really came from us.

Setting one up

Add a URL in the app under Settings → Connections → Send to your tools, or with POST https://programmable.page/api/webhooks and {"url": "https://…", "events": ["widget.event", "customer.created"]} (leave out events, or send ["*"], for every event, including ones added later). Add boardId to hear only about one page (or every page made from a template); a subscription narrowed to a page doesn't get customer.* events, which aren't about a page. The signing secret is returned once, when you add the URL, and again when you rotate it. See the API reference for the calls.

The request

Each delivery is a POST with a JSON body, the envelope:

{
  "id": "evt_…",          // the event's id: the same at every webhook it goes to, and on every retry
  "type": "customer.created",
  "createdAt": 1762419600000,  // when it happened, milliseconds since 1970 (UTC)
  "created_at": "2025-11-06T09:00:00.000Z",  // the same moment, ISO 8601 UTC (as the other Programmable apps send it)
  "livemode": true,          // false for an event from test mode (a pt_test_ key, or a page made with one)
  "data": { … }            // depends on type, below
}
HeaderWhat it is
content-typeapplication/json
programmable-page-eventThe event type, the same as type.
programmable-page-deliveryThe delivery's id (dlv_…), the same on every retry of it.
programmable-page-signatureThe signature, below.
x-programmable-id, x-programmable-event, x-programmable-signatureThe same delivery id, event type and signature under the header names every Programmable app uses, so one verifier works for all of them.
user-agentprogrammable-page-Webhooks/1

The older panelboard-event, panelboard-delivery and panelboard-signature headers are still sent, with the same values, for receivers written before the rename.

Answer with any 2xx within 10 seconds. Anything else counts as a failure, including redirects (they aren't followed) and a slow answer. Do the work after answering, or in a queue, if it takes longer.

Checking the signature

The programmable-page-signature header looks like this:

t=1762419600,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd

t is when this attempt was signed, in seconds since 1970. v1 is the lowercase hex HMAC-SHA256 of t, a full stop, and the raw request body, keyed with your signing secret (the whole whsec_… string):

v1 = hex(HMAC_SHA256(key = secret, message = t + "." + rawBody))
  1. Split the header on commas, and each part on the first =. Take t and every v1.
  2. Compute the HMAC over the body exactly as it arrived. Parse the JSON only afterwards: re-serializing it changes the bytes.
  3. Accept the delivery if any v1 equals what you computed (compare in constant time).
  4. Refuse it if t is more than 5 minutes from your clock. Every attempt, retries included, is signed when it's sent, so a genuine delivery is never older than that; an old one replayed is.

There can be more than one v1: for 24 hours after you rotate a secret, deliveries carry one signature from the new secret and one from the previous one (t=…,v1=<new>,v1=<previous>), then only the new one again. Check every v1, not just the first, and the switch-over needs no coordination. The samples below do.

Node.js

import { createHmac, timingSafeEqual } from "node:crypto";

// rawBody: the request body exactly as received (a string or Buffer), before any JSON parsing.
// header: the programmable-page-signature header.
export function verifyWebhook(secret, header, rawBody, toleranceSec = 300) {
  const parts = String(header ?? "").split(",").map((p) => p.trim().split("="));
  const t = Number(parts.find(([k]) => k === "t")?.[1]);
  const sigs = parts.filter(([k, v]) => k === "v1" && v).map(([, v]) => v);
  if (!Number.isInteger(t) || Math.abs(Date.now() / 1000 - t) > toleranceSec || sigs.length === 0) return false;
  const expected = createHmac("sha256", secret).update(`${t}.`).update(rawBody).digest();
  // While a secret is being rotated there are two v1 values; any one matching is enough.
  return sigs.some((v) => {
    const got = Buffer.from(v, "hex");
    return got.length === expected.length && timingSafeEqual(got, expected);
  });
}

// Express: app.post("/hook", express.raw({ type: "application/json" }), (req, res) => {
//   if (!verifyWebhook(process.env.WEBHOOK_SECRET, req.get("programmable-page-signature"), req.body)) return res.sendStatus(400);
//   const event = JSON.parse(req.body);
//   res.sendStatus(200);
// });

Python

import hashlib
import hmac
import time


def verify_webhook(secret: str, header: str, raw_body: bytes, tolerance_sec: int = 300) -> bool:
    """raw_body: the request body exactly as received, before any JSON parsing."""
    pairs = [p.strip().split("=", 1) for p in (header or "").split(",")]
    pairs = [p for p in pairs if len(p) == 2]
    t = next((v for k, v in pairs if k == "t"), None)
    sigs = [v for k, v in pairs if k == "v1" and v]
    if t is None or not t.isdigit() or abs(time.time() - int(t)) > tolerance_sec or not sigs:
        return False
    expected = hmac.new(secret.encode(), t.encode() + b"." + raw_body, hashlib.sha256).hexdigest()
    # While a secret is being rotated there are two v1 values; any one matching is enough.
    return any(hmac.compare_digest(expected, v) for v in sigs)


# Flask:
# @app.post("/hook")
# def hook():
#     if not verify_webhook(os.environ["WEBHOOK_SECRET"], request.headers.get("programmable-page-signature", ""), request.get_data()):
#         abort(400)
#     event = request.get_json()
#     return "", 200

PHP

<?php
// $rawBody: the request body exactly as received: file_get_contents('php://input').
function verify_webhook(string $secret, string $header, string $rawBody, int $toleranceSec = 300): bool {
    $t = null;
    $sigs = [];
    foreach (explode(',', $header) as $part) {
        $kv = explode('=', trim($part), 2);
        if (count($kv) !== 2) continue;
        if ($kv[0] === 't') $t = $kv[1];
        elseif ($kv[0] === 'v1' && $kv[1] !== '') $sigs[] = $kv[1];
    }
    if ($t === null || !ctype_digit($t) || abs(time() - (int) $t) > $toleranceSec || !$sigs) return false;
    $expected = hash_hmac('sha256', $t . '.' . $rawBody, $secret);
    // While a secret is being rotated there are two v1 values; any one matching is enough.
    foreach ($sigs as $sig) {
        if (hash_equals($expected, $sig)) return true;
    }
    return false;
}

// $raw = file_get_contents('php://input');
// if (!verify_webhook(getenv('WEBHOOK_SECRET'), $_SERVER['HTTP_PROGRAMMABLE_PAGE_SIGNATURE'] ?? '', $raw)) {
//     http_response_code(400);
//     exit;
// }
// $event = json_decode($raw, true);

Rotating the secret

Rotate with the key button next to the webhook (Settings → Connections → Send to your tools), or POST /api/webhooks/:id/rotate, which returns the new secret. For the next 24 hours every delivery is signed with both the new and the previous secret, so your receiver keeps verifying whichever one it has while you deploy the new one. After that, only the new secret signs. Rotating again within the 24 hours drops the oldest secret at once. (The workspace's page callback secret, /api/webhooks/callback-secret/rotate, changes at once.)

Retries, switching off and redelivery

A failed delivery is tried again after 30 seconds, 2 minutes, 10 minutes, 1 hour, 6 hours (each ±20%, so a receiver coming back from an outage isn't hit all at once): 6 attempts in all. After the last one it's marked failed. A test ping isn't retried.

After 20 failed attempts in a row (across all of a webhook's deliveries), the webhook is switched off and says why in the app. Switch it back on (the app, or PATCH /api/webhooks/:id with {"enabled": true}) and deliveries that were still waiting go out again.

Recent deliveries and how each went are listed under the webhook (GET /api/webhooks/:id/deliveries). A failed one can be sent again with POST /api/webhooks/:id/deliveries/:deliveryId/redeliver for 7 days after the event. A delivered payload is erased once it's delivered, so a delivered event can't be sent again: keep what you need from it.

Duplicates and order

Delivery is at least once: a retry after a timeout, or a redelivery, can bring an event you already handled. Store each event's id as you process it and skip ones you've seen (a unique key on it is enough). Retries and redeliveries keep the same id; two webhooks on the same URL each get their own.

Deliveries go out in parallel and retries come later, so events can arrive out of order. Use createdAt, and for a page, data.board.version, to tell which is newer; don't assume board.created arrives before board.updated.

Events

KindEvents
Pagesboard.created board.updated board.deleted board.generated board.generation_failed page.sent text.status page.viewed quote.accepted quote.declined request.answered
Moneypage.voided payment.completed payment.refunded payment.disputed accounting.synced subscription.updated subscription.paid
Replies and fileswidget.event widget.upload
Bookingsbooking.created booking.moved booking.cancelled calendar.synced
Customerscustomer.created customer.updated customer.deleted customer.restored
Jobsjob.finished
Testingping

Events about a page carry data.board: its id, title, kind, visibility, status, version, template, workspace, your ref, its links and its template data. Never its content or the prompt it was made from. Amounts are in minor units (cents), and times in milliseconds since 1970, UTC.

Pages

board.created

A page was made: in the app, through the API or MCP, from a template, or from a text or email.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "board.created",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m"
  }
}

board.updated

A page changed. fields lists what changed, e.g. content, data, title, answer, payment (its bill was cancelled or restored; a cancel also sends page.voided), or deletedAt when it came back out of the Trash. boardId is the page's id (the same as board.id). refs says which records it became elsewhere, keyed by provider and kind (refs.quickbooks.invoice.id, refs.xero.invoice.id, refs.quickbooks.payment.id); a provider or kind with nothing is left out. refs_all lists every one, oldest first.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "board.updated",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "fields": [
      "data"
    ],
    "refs": {
      "quickbooks": {
        "invoice": {
          "id": "147",
          "number": "1042"
        },
        "payment": {
          "id": "212"
        }
      }
    },
    "refs_all": [
      {
        "provider": "quickbooks",
        "kind": "invoice",
        "id": "147",
        "number": "1042",
        "createdAt": 1762416000000,
        "source": "page_sync"
      },
      {
        "provider": "quickbooks",
        "kind": "payment",
        "id": "212",
        "createdAt": 1762419600000,
        "source": "page_sync"
      }
    ]
  }
}

board.deleted

A page was moved to the Trash, or deleted for good without going there first.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "board.deleted",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m"
  }
}

board.generated

A page being written from a description is ready.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "board.generated",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m"
  }
}

board.generation_failed

A page being written from a description couldn't be made.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "board.generation_failed",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "error": "The model didn't answer in time."
  }
}

page.sent

You sent a page to someone by text or email. to is the phone number or email it went to; customerId the saved customer it went to (null when not saved). boardId is the page's id (the same as board.id). refs says which records it became elsewhere, keyed by provider and kind (refs.quickbooks.invoice.id, refs.xero.invoice.id, refs.quickbooks.payment.id); a provider or kind with nothing is left out. refs_all lists every one, oldest first. An invoice our sync is still adding to the books arrives in accounting.synced.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "page.sent",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "channel": "email",
    "to": "[email protected]",
    "customerId": "cus_8f3k2m9q1x7v4t",
    "at": 1762419600000,
    "refs": {
      "quickbooks": {
        "invoice": {
          "id": "147",
          "number": "1042"
        },
        "payment": {
          "id": "212"
        }
      }
    },
    "refs_all": [
      {
        "provider": "quickbooks",
        "kind": "invoice",
        "id": "147",
        "number": "1042",
        "createdAt": 1762416000000,
        "source": "page_sync"
      },
      {
        "provider": "quickbooks",
        "kind": "payment",
        "id": "212",
        "createdAt": 1762419600000,
        "source": "page_sync"
      }
    ]
  }
}

text.status

A page you texted reached its final delivery status, as the carrier reported it: delivered, undelivered or failed. errorCode is Twilio's error code when there is one (e.g. 30003 unreachable, 30005 unknown number, 30006 landline, 30007 filtered by the carrier, 21610 they replied STOP). Sent once per text; messageId is the provider's message id.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "text.status",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "text": {
      "messageId": "SM0123456789abcdef0123456789abcdef",
      "to": "+15550102030",
      "status": "undelivered",
      "errorCode": "30003",
      "sentAt": 1762419540000
    },
    "at": 1762419600000
  }
}

page.viewed

A page had its first visit of the day (UTC). Sent at most once per page per day, however many people open it, so it can't flood you. Link previewers, crawlers and your own previews in the app don't count.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "page.viewed",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "day": "2025-11-06",
    "at": 1762419600000
  }
}

quote.accepted

A customer accepted a quote or estimate.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "quote.accepted",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "acceptance": {
      "name": "Sarah Lee",
      "note": "Please start Monday.",
      "acceptedAt": 1762419600000
    }
  }
}

quote.declined

A customer said "not this time" to a quote or estimate. name and reason are what they typed, or null. Follow-ups for it stop.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "quote.declined",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "decline": {
      "name": "Sarah Lee",
      "reason": "We went with another quote.",
      "declinedAt": 1762419600000
    }
  }
}

request.answered

A request page got its one answer: a reply, a payment or an acceptance. Carries the page's ref.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "request.answered",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "answer": {
      "type": "reply",
      "event": "approve",
      "data": {
        "ok": true
      },
      "at": 1762419600000,
      "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
    }
  }
}

Money

page.voided

You cancelled a page's bill (an invoice, a quote): nothing is owed and its Pay button is off. Sent once per cancel; board.updated with fields: ["payment"] is still sent too. boardId is the page's id (the same as board.id). refs says which records it became elsewhere, keyed by provider and kind (refs.quickbooks.invoice.id, refs.xero.invoice.id, refs.quickbooks.payment.id); a provider or kind with nothing is left out. refs_all lists every one, oldest first. Void your own copies by these ids; our QuickBooks or Xero sync voids the invoice it made by itself.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "page.voided",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "at": 1762419600000,
    "refs": {
      "quickbooks": {
        "invoice": {
          "id": "147",
          "number": "1042"
        },
        "payment": {
          "id": "212"
        }
      }
    },
    "refs_all": [
      {
        "provider": "quickbooks",
        "kind": "invoice",
        "id": "147",
        "number": "1042",
        "createdAt": 1762416000000,
        "source": "page_sync"
      },
      {
        "provider": "quickbooks",
        "kind": "payment",
        "id": "212",
        "createdAt": 1762419600000,
        "source": "page_sync"
      }
    ]
  }
}

payment.completed

A payment came in: through a page's Pay button (Stripe, on your own account), or marked paid by you (method: "offline"). boardId is the page's id (the same as board.id). refs says which records it became elsewhere, keyed by provider and kind (refs.quickbooks.invoice.id, refs.xero.invoice.id, refs.quickbooks.payment.id); a provider or kind with nothing is left out. refs_all lists every one, oldest first. The payment our books sync records arrives in accounting.synced.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "payment.completed",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "payment": {
      "id": "pay_2n8x4k1q",
      "amount": 9500,
      "currency": "usd",
      "description": "Invoice #1042",
      "customerEmail": "[email protected]",
      "paidAt": 1762419600000,
      "mode": "live"
    },
    "refs": {
      "quickbooks": {
        "invoice": {
          "id": "147",
          "number": "1042"
        },
        "payment": {
          "id": "212"
        }
      }
    },
    "refs_all": [
      {
        "provider": "quickbooks",
        "kind": "invoice",
        "id": "147",
        "number": "1042",
        "createdAt": 1762416000000,
        "source": "page_sync"
      },
      {
        "provider": "quickbooks",
        "kind": "payment",
        "id": "212",
        "createdAt": 1762419600000,
        "source": "page_sync"
      }
    ]
  }
}

payment.refunded

You refunded all or part of a payment. Amounts are in minor units (cents). boardId is the page's id (the same as board.id). refs says which records it became elsewhere, keyed by provider and kind (refs.quickbooks.invoice.id, refs.xero.invoice.id, refs.quickbooks.payment.id); a provider or kind with nothing is left out. refs_all lists every one, oldest first.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "payment.refunded",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "payment": {
      "id": "pay_2n8x4k1q",
      "amount": 9500,
      "currency": "usd",
      "customerEmail": "[email protected]",
      "mode": "live",
      "refundedAmount": 2500
    },
    "refund": {
      "id": "rf_9x2k4m",
      "amount": 2500,
      "currency": "usd",
      "reason": "requested_by_customer",
      "stripeRefundId": "re_3Q…",
      "createdAt": 1762419600000
    },
    "refs": {
      "quickbooks": {
        "invoice": {
          "id": "147",
          "number": "1042"
        },
        "payment": {
          "id": "212"
        }
      }
    },
    "refs_all": [
      {
        "provider": "quickbooks",
        "kind": "invoice",
        "id": "147",
        "number": "1042",
        "createdAt": 1762416000000,
        "source": "page_sync"
      },
      {
        "provider": "quickbooks",
        "kind": "payment",
        "id": "212",
        "createdAt": 1762419600000,
        "source": "page_sync"
      }
    ]
  }
}

payment.disputed

A customer's bank opened, updated or decided a chargeback. previous is the status before (null when it just opened). boardId is the page's id (the same as board.id). refs says which records it became elsewhere, keyed by provider and kind (refs.quickbooks.invoice.id, refs.xero.invoice.id, refs.quickbooks.payment.id); a provider or kind with nothing is left out. refs_all lists every one, oldest first.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "payment.disputed",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "payment": {
      "id": "pay_2n8x4k1q",
      "amount": 9500,
      "currency": "usd",
      "customerEmail": "[email protected]",
      "mode": "live"
    },
    "dispute": {
      "id": "dp_1Q…",
      "amount": 9500,
      "currency": "usd",
      "reason": "fraudulent",
      "status": "needs_response",
      "evidenceDue": 1763024400000
    },
    "previous": null,
    "refs": {
      "quickbooks": {
        "invoice": {
          "id": "147",
          "number": "1042"
        },
        "payment": {
          "id": "212"
        }
      }
    },
    "refs_all": [
      {
        "provider": "quickbooks",
        "kind": "invoice",
        "id": "147",
        "number": "1042",
        "createdAt": 1762416000000,
        "source": "page_sync"
      },
      {
        "provider": "quickbooks",
        "kind": "payment",
        "id": "212",
        "createdAt": 1762419600000,
        "source": "page_sync"
      }
    ]
  }
}

accounting.synced

Our QuickBooks or Xero sync recorded a record in the books: the page's invoice (kind: "invoice", made when it was sent or paid, or made again after a cancelled bill was restored), a payment against it (payment), a QuickBooks refund receipt (refund) or a Xero credit note (credit_note). synced is that record (provider, kind, id, number when there is one); trigger is the event it answered (page.sent, payment.completed, payment.refunded, board.updated) or manual (Send unpaid invoices, Retry). refs is the page's refs after it: refs.quickbooks.invoice.id, refs.xero.invoice.id (Xero's InvoiceID).

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "accounting.synced",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "synced": {
      "provider": "quickbooks",
      "kind": "payment",
      "id": "212"
    },
    "trigger": "payment.completed",
    "at": 1762419600000,
    "refs": {
      "quickbooks": {
        "invoice": {
          "id": "147",
          "number": "1042"
        },
        "payment": {
          "id": "212"
        }
      }
    },
    "refs_all": [
      {
        "provider": "quickbooks",
        "kind": "invoice",
        "id": "147",
        "number": "1042",
        "createdAt": 1762416000000,
        "source": "page_sync"
      },
      {
        "provider": "quickbooks",
        "kind": "payment",
        "id": "212",
        "createdAt": 1762419600000,
        "source": "page_sync"
      }
    ]
  }
}

subscription.updated

A membership or retainer started, changed, fell behind or ended. previous is null when it just started.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "subscription.updated",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "subscription": {
      "id": "sub_6k2m9x",
      "boardId": "k3v9xq2m",
      "amount": 4900,
      "currency": "usd",
      "interval": "month",
      "status": "active",
      "cancelAtPeriodEnd": false,
      "currentPeriodEnd": 1765011600000,
      "customerEmail": "[email protected]",
      "createdAt": 1762419600000
    },
    "previous": null
  }
}

subscription.paid

A membership or retainer payment came in: the first one (first: true, alongside subscription.updated) or a renewal. Amounts are in minor units (cents). payment.completed is not sent for these.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "subscription.paid",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "payment": {
      "id": "pay_7m3q9x2k",
      "amount": 4900,
      "currency": "usd",
      "customerEmail": "[email protected]",
      "paidAt": 1762419600000,
      "mode": "live"
    },
    "subscription": {
      "id": "sub_6k2m9x",
      "interval": "month"
    },
    "first": false
  }
}

Replies and files

widget.event

A visitor sent something from a page that collects replies (a lead form, a choice, a message). name is the event name the page used, and data is what the page sent. A scored page with named results (the Instant estimate with results) adds data.result: { id, name, score }, the result the visitor reached, so you can branch on data.result.id or data.result.name; it's absent otherwise. When the form showed an email-marketing consent box (the page's data has marketingConsent), consent sits beside name and data: { marketing, text, at }. marketing is true only if the visitor ticked the box asking for marketing email (email only, never texts); text is the exact wording the box showed; at is when we received it (ISO 8601). We set it from the page's own data, never from what the page sent, so a page's script can't fake it or change the wording. consent is absent when the form had no box: treat absent like marketing: false.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "widget.event",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "name": "lead",
    "data": {
      "name": "Sarah Lee",
      "email": "[email protected]",
      "message": "Do you have Saturday slots?",
      "result": {
        "id": "full-refit",
        "name": "Full refit",
        "score": 18500
      }
    },
    "consent": {
      "marketing": true,
      "text": "Email me news and offers from Ada's Plumbing. I can unsubscribe at any time.",
      "at": "2025-11-06T09:00:00.000Z"
    },
    "at": 1762419600000
  }
}

widget.upload

A visitor uploaded a file through a page; the file went to your connected storage.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "widget.upload",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "file": {
      "id": "f_3k9x2m",
      "name": "photo.jpg",
      "size": 482133,
      "type": "image/jpeg",
      "url": "https://storage.example.com/uploads/photo.jpg"
    },
    "connectionId": "conn_4m2x9k",
    "at": 1762419600000
  }
}

Bookings

booking.created

A booking was made, by a customer on a booking page or by you. start and end are minutes after midnight on date; by is customer or owner. Sent for every booking, whoever made it (a customer's also arrives as widget.event). boardId is the booking page's id (the same as board.id). refs is the booking's own: refs.google_calendar.calendar_event.id (and calendarId) is its event in the connected calendar, plus any a workflow attached. booking.calendarEventId is the same id. The calendar event is often made just after this is sent: calendar.synced says when.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "booking.created",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "booking": {
      "id": "bk_7q2m9x4k",
      "status": "booked",
      "date": "2025-11-12",
      "start": 600,
      "end": 660,
      "name": "Sarah Lee",
      "email": "[email protected]",
      "phone": "+15550102030",
      "summary": "Haircut",
      "calendarEventId": null,
      "calendarProvider": null
    },
    "by": "customer",
    "at": 1762419600000,
    "refs": {},
    "refs_all": []
  }
}

booking.moved

A booking was moved to another time. previous is where it was. boardId is the booking page's id (the same as board.id). refs is the booking's own: refs.google_calendar.calendar_event.id (and calendarId) is its event in the connected calendar, plus any a workflow attached. booking.calendarEventId is the same id.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "booking.moved",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "booking": {
      "id": "bk_7q2m9x4k",
      "status": "booked",
      "date": "2025-11-12",
      "start": 720,
      "end": 780,
      "name": "Sarah Lee",
      "email": "[email protected]",
      "phone": "+15550102030",
      "summary": "Haircut",
      "calendarEventId": "7m3q9x2k4v8n1p5t0b6c",
      "calendarProvider": "google_calendar"
    },
    "previous": {
      "date": "2025-11-12",
      "start": 600,
      "end": 660
    },
    "by": "owner",
    "at": 1762419600000,
    "refs": {
      "google_calendar": {
        "calendar_event": {
          "id": "7m3q9x2k4v8n1p5t0b6c",
          "calendarId": "primary"
        }
      }
    },
    "refs_all": [
      {
        "provider": "google_calendar",
        "kind": "calendar_event",
        "id": "7m3q9x2k4v8n1p5t0b6c",
        "calendarId": "primary",
        "createdAt": 1762419600000,
        "source": "page_sync"
      }
    ]
  }
}

booking.cancelled

A booking was cancelled, by the customer or by you. boardId is the booking page's id (the same as board.id). refs is the booking's own: refs.google_calendar.calendar_event.id (and calendarId) is its event in the connected calendar, plus any a workflow attached. booking.calendarEventId is the same id. They name the event as it was before our sync deleted it from the calendar.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "booking.cancelled",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "booking": {
      "id": "bk_7q2m9x4k",
      "status": "cancelled",
      "date": "2025-11-12",
      "start": 600,
      "end": 660,
      "name": "Sarah Lee",
      "email": "[email protected]",
      "phone": "+15550102030",
      "summary": "Haircut",
      "calendarEventId": "7m3q9x2k4v8n1p5t0b6c",
      "calendarProvider": "google_calendar"
    },
    "by": "customer",
    "at": 1762419600000,
    "refs": {
      "google_calendar": {
        "calendar_event": {
          "id": "7m3q9x2k4v8n1p5t0b6c",
          "calendarId": "primary"
        }
      }
    },
    "refs_all": [
      {
        "provider": "google_calendar",
        "kind": "calendar_event",
        "id": "7m3q9x2k4v8n1p5t0b6c",
        "calendarId": "primary",
        "createdAt": 1762419600000,
        "source": "page_sync"
      }
    ]
  }
}

calendar.synced

Our Google Calendar sync made (action: "created"), moved (moved) or deleted (deleted) a booking's calendar event. calendarEventId and calendarId say which; synced is what it changed (provider, kind, the event's id and calendarId), the same shape as accounting.synced; refs is the booking's refs after the change (a deleted event is no longer in them). board is left out when the booking's page is gone.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "calendar.synced",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "board": {
      "id": "k3v9xq2m",
      "title": "Invoice #1042",
      "kind": "html",
      "visibility": "unlisted",
      "status": "active",
      "version": 3,
      "templateId": "t7wp4r8n",
      "publisherId": "pub_5d2c8a1f9e",
      "ref": "order-1042",
      "viewUrl": "https://programmable.page/v/k3v9xq2m",
      "embedUrl": "https://programmable.page/b/k3v9xq2m",
      "data": {
        "customer": {
          "name": "Sarah Lee"
        },
        "total": 95
      }
    },
    "boardId": "k3v9xq2m",
    "bookingId": "bk_7q2m9x4k",
    "booking": {
      "id": "bk_7q2m9x4k",
      "status": "booked",
      "date": "2025-11-12",
      "start": 600,
      "end": 660,
      "name": "Sarah Lee",
      "email": "[email protected]",
      "phone": "+15550102030",
      "summary": "Haircut",
      "calendarEventId": "7m3q9x2k4v8n1p5t0b6c",
      "calendarProvider": "google_calendar"
    },
    "action": "created",
    "provider": "google_calendar",
    "calendarEventId": "7m3q9x2k4v8n1p5t0b6c",
    "calendarId": "primary",
    "synced": {
      "provider": "google_calendar",
      "kind": "calendar_event",
      "id": "7m3q9x2k4v8n1p5t0b6c",
      "calendarId": "primary"
    },
    "at": 1762419600000,
    "refs": {
      "google_calendar": {
        "calendar_event": {
          "id": "7m3q9x2k4v8n1p5t0b6c",
          "calendarId": "primary"
        }
      }
    },
    "refs_all": [
      {
        "provider": "google_calendar",
        "kind": "calendar_event",
        "id": "7m3q9x2k4v8n1p5t0b6c",
        "calendarId": "primary",
        "createdAt": 1762419600000,
        "source": "page_sync"
      }
    ]
  }
}

Customers

customer.created

A customer was saved: by you, by an import, by sending a page to someone new, or by saving who replied or booked.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "customer.created",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "customer": {
      "id": "cus_8f3k2m9q1x7v4t",
      "publisherId": "pub_5d2c8a1f9e",
      "name": "Sarah Lee",
      "email": "[email protected]",
      "phone": "+15550102030",
      "address": "12 High Street, Springfield",
      "notes": "Prefers mornings.",
      "smsConsentAt": 1762333200000,
      "smsConsentMethod": "signed_form",
      "smsConsentBy": "usr_3k9d2m",
      "smsConsentRef": null,
      "smsMarketingAt": 1762333200000,
      "emailMarketingAt": 1762333200000,
      "emailMarketingMethod": "form_checkbox",
      "emailMarketingText": "Email me news and offers from Ada's Plumbing. I can unsubscribe at any time.",
      "emailMarketingRef": "k3v9xq2m",
      "emailMarketingWithdrawnAt": null,
      "smsUnreachableAt": null,
      "smsUnreachableNote": null,
      "emailBouncedAt": null,
      "emailBouncedNote": null,
      "timeZone": "America/New_York",
      "language": null,
      "createdAt": 1762333200000,
      "updatedAt": 1762419600000
    },
    "at": 1762419600000
  }
}

customer.updated

A customer's details changed (by you, an import filling in blanks, or a send or reply adding a phone or email). fields lists what changed.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "customer.updated",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "customer": {
      "id": "cus_8f3k2m9q1x7v4t",
      "publisherId": "pub_5d2c8a1f9e",
      "name": "Sarah Lee",
      "email": "[email protected]",
      "phone": "+15550102030",
      "address": "12 High Street, Springfield",
      "notes": "Prefers mornings.",
      "smsConsentAt": 1762333200000,
      "smsConsentMethod": "signed_form",
      "smsConsentBy": "usr_3k9d2m",
      "smsConsentRef": null,
      "smsMarketingAt": 1762333200000,
      "emailMarketingAt": 1762333200000,
      "emailMarketingMethod": "form_checkbox",
      "emailMarketingText": "Email me news and offers from Ada's Plumbing. I can unsubscribe at any time.",
      "emailMarketingRef": "k3v9xq2m",
      "emailMarketingWithdrawnAt": null,
      "smsUnreachableAt": null,
      "smsUnreachableNote": null,
      "emailBouncedAt": null,
      "emailBouncedNote": null,
      "timeZone": "America/New_York",
      "language": null,
      "createdAt": 1762333200000,
      "updatedAt": 1762419600000
    },
    "fields": [
      "phone"
    ],
    "at": 1762419600000
  }
}

customer.deleted

A customer was moved to the Trash. They can be restored for 30 days, then they're deleted for good (no further event).

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "customer.deleted",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "customer": {
      "id": "cus_8f3k2m9q1x7v4t",
      "publisherId": "pub_5d2c8a1f9e",
      "name": "Sarah Lee",
      "email": "[email protected]",
      "phone": "+15550102030",
      "address": "12 High Street, Springfield",
      "notes": "Prefers mornings.",
      "smsConsentAt": 1762333200000,
      "smsConsentMethod": "signed_form",
      "smsConsentBy": "usr_3k9d2m",
      "smsConsentRef": null,
      "smsMarketingAt": 1762333200000,
      "emailMarketingAt": 1762333200000,
      "emailMarketingMethod": "form_checkbox",
      "emailMarketingText": "Email me news and offers from Ada's Plumbing. I can unsubscribe at any time.",
      "emailMarketingRef": "k3v9xq2m",
      "emailMarketingWithdrawnAt": null,
      "smsUnreachableAt": null,
      "smsUnreachableNote": null,
      "emailBouncedAt": null,
      "emailBouncedNote": null,
      "timeZone": "America/New_York",
      "language": null,
      "createdAt": 1762333200000,
      "updatedAt": 1762419600000
    },
    "at": 1762419600000
  }
}

customer.restored

A customer was taken back out of the Trash.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "customer.restored",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "customer": {
      "id": "cus_8f3k2m9q1x7v4t",
      "publisherId": "pub_5d2c8a1f9e",
      "name": "Sarah Lee",
      "email": "[email protected]",
      "phone": "+15550102030",
      "address": "12 High Street, Springfield",
      "notes": "Prefers mornings.",
      "smsConsentAt": 1762333200000,
      "smsConsentMethod": "signed_form",
      "smsConsentBy": "usr_3k9d2m",
      "smsConsentRef": null,
      "smsMarketingAt": 1762333200000,
      "emailMarketingAt": 1762333200000,
      "emailMarketingMethod": "form_checkbox",
      "emailMarketingText": "Email me news and offers from Ada's Plumbing. I can unsubscribe at any time.",
      "emailMarketingRef": "k3v9xq2m",
      "emailMarketingWithdrawnAt": null,
      "smsUnreachableAt": null,
      "smsUnreachableNote": null,
      "emailBouncedAt": null,
      "emailBouncedNote": null,
      "timeZone": "America/New_York",
      "language": null,
      "createdAt": 1762333200000,
      "updatedAt": 1762419600000
    },
    "at": 1762419600000
  }
}

Jobs

job.finished

A job (a PDF, a script, a bulk run) finished: status is ok, failed, timeout, refused or cancelled. outputs says what it made (a page, pages from a template, files to download until expiresAt). Its inputs and log are never sent.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "job.finished",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "job": {
      "id": "job_4k9x2m7q",
      "recipeId": "invoice-pdf",
      "status": "ok",
      "trigger": "api",
      "error": null,
      "outputs": {
        "boardId": "k3v9xq2m",
        "instances": [],
        "summary": null,
        "files": [
          {
            "id": "f_8m2k4x",
            "name": "invoice-1042.pdf",
            "size": 48213,
            "type": "application/pdf",
            "expiresAt": 1763024400000
          }
        ]
      },
      "createdAt": 1762419580000,
      "startedAt": 1762419585000,
      "finishedAt": 1762419600000
    }
  }
}

Testing

ping

Sent when you press Test (or call POST /api/webhooks/:id/test), to check your endpoint. Not retried, whatever it answers. Send {"event": "<name>"} to that call instead to get any event's example below, with livemode: false.

{
  "id": "evt_3f9c2a7b1d8e4f60a2b5c9d1e7f3a8b4",
  "type": "ping",
  "createdAt": 1762419600000,
  "livemode": true,
  "data": {
    "subscriptionId": "wh_8k2m4x9q1v3t7n5p",
    "message": "programmable-page webhook test"
  }
}