Lumen · Developers

Events

Every event we can send, with an example body.

Orders

order.created

An order was placed, before payment.

Sent to 2 endpoints

Example body

{
  "type": "order.created",
  "data": {
    "id": "ord_99312",
    "object": "order",
    "status": "open",
    "total": 8450,
    "currency": "eur",
    "items": [
      {
        "sku": "MUG-ST-01",
        "name": "Stoneware mug",
        "qty": 2,
        "price": 2400
      },
      {
        "sku": "TEA-GR-500",
        "name": "Green tea 500 g",
        "qty": 1,
        "price": 3650
      }
    ],
    "customer": {
      "id": "cus_4821",
      "email": "mia.brandt@example.com"
    },
    "created": "2026-10-19T14:21:07Z"
  }
}

order.createdOrders

An order was placed, before payment.

Sent to 2 endpoints

Example body

{
  "type": "order.created",
  "data": {
    "id": "ord_99312",
    "object": "order",
    "status": "open",
    "total": 8450,
    "currency": "eur",
    "items": [
      {
        "sku": "MUG-ST-01",
        "name": "Stoneware mug",
        "qty": 2,
        "price": 2400
      },
      {
        "sku": "TEA-GR-500",
        "name": "Green tea 500 g",
        "qty": 1,
        "price": 3650
      }
    ],
    "customer": {
      "id": "cus_4821",
      "email": "mia.brandt@example.com"
    },
    "created": "2026-10-19T14:21:07Z"
  }
}

order.paidOrders

Payment arrived, the order can ship.

Sent to 3 endpoints

Example body

{
  "type": "order.paid",
  "data": {
    "id": "ord_99312",
    "object": "order",
    "status": "paid",
    "total": 8450,
    "currency": "eur",
    "items": [
      {
        "sku": "MUG-ST-01",
        "name": "Stoneware mug",
        "qty": 2,
        "price": 2400
      },
      {
        "sku": "TEA-GR-500",
        "name": "Green tea 500 g",
        "qty": 1,
        "price": 3650
      }
    ],
    "customer": {
      "id": "cus_4821",
      "email": "mia.brandt@example.com"
    },
    "created": "2026-10-19T14:21:07Z"
  }
}

order.shippedOrders

The parcel has a tracking number.

Sent to 1 endpoint

Example body

{
  "type": "order.shipped",
  "data": {
    "id": "ord_99312",
    "tracking": "NW-7714-2209",
    "carrier": "parcel"
  }
}

order.cancelledOrders

The order was cancelled, before or after payment.

Sent to 2 endpoints

Example body

{
  "type": "order.cancelled",
  "data": {
    "id": "ord_99307",
    "reason": "customer_request"
  }
}

customer.createdCustomers

A new customer account was created.

Sent to 2 endpoints

Example body

{
  "type": "customer.created",
  "data": {
    "id": "cus_4821",
    "email": "mia.brandt@example.com",
    "newsletter": true
  }
}

customer.updatedCustomers

Contact details or the address changed.

Sent to 2 endpoints

Example body

{
  "type": "customer.updated",
  "data": {
    "id": "cus_4821",
    "changed": [
      "address"
    ]
  }
}

payment.failedPayments

A payment was declined.

Sent to 1 endpoint

Example body

{
  "type": "payment.failed",
  "data": {
    "order": "ord_99318",
    "code": "card_declined",
    "amount": 4200
  }
}

refund.createdPayments

An amount was refunded in full or in part.

Sent to 1 endpoint

Example body

{
  "type": "refund.created",
  "data": {
    "order": "ord_99212",
    "amount": 2400
  }
}

stock.lowStock

An item drops below its minimum stock.

Sent to 2 endpoints

Example body

{
  "type": "stock.low",
  "data": {
    "sku": "TEA-GR-500",
    "left": 6,
    "minimum": 10
  }
}