Skip to content

category.created

A category was created: when BIRP sends this event, what its data holds and an example of its body.

Version v1.2, updated

On this page

BIRP sends category.created to the webhook endpoints that receive it. This page says when it is sent and what data holds, with an example of the body.

When it is sent

A category was created in BIRP or through the API.

Data

data holds a category, with the fields of Categories.

Example

Body of category.createdJSON
{
  "api_version": "v1",
  "data": {
    "created_at": "2026-09-01T07:30:00.000Z",
    "description": "Flours for resale",
    "external_ids": [],
    "id": "00000000-0000-4000-8000-000000000021",
    "name": "Flour",
    "product_kind": "goods",
    "updated_at": "2026-09-28T14:05:12.417Z"
  },
  "id": "00000000-0000-4000-8000-000000000104",
  "occurred_at": "2026-09-28T14:05:12.417Z",
  "type": "category.created"
}

Related

  • webhook-events
  • categories
  • verify-webhook-signatures