Skip to content

customer.created

A customer 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 customer.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 customer was created in BIRP or through the API.

Data

data holds a customer, with the fields of Customers.

Example

Body of customer.createdJSON
{
  "api_version": "v1",
  "data": {
    "address": {
      "city": "Paris",
      "country": "France",
      "line1": "12 rue des Exemples",
      "line2": null,
      "postal_code": "00000"
    },
    "contact_name": "Claire Exemple",
    "country_code": "FR",
    "created_at": "2026-09-01T07:30:00.000Z",
    "customer_type": "b2b",
    "email": "achats@example.com",
    "external_ids": [
      {
        "external_id": "cust-77",
        "source": "woocommerce"
      }
    ],
    "id": "00000000-0000-4000-8000-000000000031",
    "name": "Epicerie Exemple SARL",
    "phone": "+33 0 00 00 00 00",
    "registration_number": "EXAMPLE-0002",
    "updated_at": "2026-09-28T14:05:12.417Z",
    "vat_number": "EXAMPLE-VAT-0002"
  },
  "id": "00000000-0000-4000-8000-000000000107",
  "occurred_at": "2026-09-28T14:05:12.417Z",
  "type": "customer.created"
}

Related

  • webhook-events
  • customers-resource
  • verify-webhook-signatures