Login / Register
POST
/api/public/v1/webhooks/generic

Generic webhook

Send Pixelbase data from any other system — a point of sale, a form tool, a spreadsheet script, your own backend — without a dedicated integration. Any body is accepted: JSON, form data, CSV or plain text. Set `Content-Type` to say what it is; a body sent as JSON must parse, or the delivery is refused with a `400` so a broken sender finds out straight away. Every accepted delivery answers `200` with a receipt: a delivery `id`, the content type and the number of bytes read. Keep the id on your side to reconcile against later. Add `?source=<key>` to store the delivery in Analytics: a JSON object, or a list of up to 500 objects, becomes records on the data source with that key, charted beside your Pixelbase numbers — a count of records, and the total of every numeric field. Create the source in Analytics → Data sources first; an unknown key is a `404` and nothing is kept. Stored records count toward your company’s storage. Without `source`, deliveries are acknowledged but not processed — nothing in your company is read or changed. Bodies are capped at 4.5 MB, and deliveries count against the company’s normal rate limit, so batch where your system allows it.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

webhooks:write

Query Parameters

NameTypeRequiredDescription
sourcestringOptionalThe key of an Analytics data source, e.g. `square-pos`. The body must then be a JSON object or a list of up to 500, each at most 64 KB.

Request Body

PropertyTypeDescription
(any)anyThe payload, in whatever shape your system sends. It must not be empty.
POSTExample request
curl
curl -X POST "https://www.pxb.app/api/public/v1/webhooks/generic" \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "event": "order.completed",
    "orderId": "ORD-10442",
    "total": 4999,
    "currency": "usd"
  }'
200Example response
json
{
  "message": "Webhook received successfully!",
  "content": {
    "delivery": {
      "id": "3f2b8c1e-6d4a-4f0e-9b7a-2c5d8e1f0a93",
      "contentType": "application/json",
      "bytes": 92,
      "receivedAt": "2026-11-11T16:04:12.000Z"
    }
  }
}
400Example response
json
{
  "message": "The body is sent as application/json but is not valid JSON."
}
404Example response
json
{
  "message": "No data source \"square-pos\". Create it in Analytics → Data sources first."
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Analytics → Data sources
/analytics/sources

Deliveries come from your other systems. Create an API client with webhooks:write under Dev Tools → API and give its token to the sender; a data source shows what has arrived.