Order Webhook Events

POSThttps://your-server.com/webhooks/easyflow

Listen to order events to keep your integration always synchronized.

Webhooks are the safest and most reliable way to stay updated in real time. Your application receives a notification whenever the status of an order changes.

When an order has items from more than one business, each business receives its own notification, and items contains only the items of that business. The totals (valueInCents, taxInCents, netValueInCents) and payments are of the whole order in every notification.

Order Events

order.created — Order created.
order.updated — Order updated.
order.paid — Order fully paid.
order.partiallyPaid — Order partially paid.
order.canceled — Order canceled.
order.refunded — Order refunded.
order.chargeback — Order chargeback received.

Example payload

{
  "event": "order.paid",
  "occurredAt": "2026-01-15T14:32:10.000Z",
  "payload": {
    "id": "2f4b6d8f-0b2d-4f6b-8d0f-2b4d6f8b0034",
    "createdAt": "2026-01-15T14:30:00.000Z",
    "updatedAt": "2026-01-15T14:32:05.000Z",
    "status": "paid",
    "paidAt": "2026-01-15T14:32:05.000Z",
    "valueInCents": 4990,
    "taxInCents": 349,
    "netValueInCents": 4641,
    "shipping": {
      "valueInCents": 0
    },
    "metadata": [
      {
        "key": "orderReference",
        "value": "ORD-1001"
      }
    ],
    "buyer": {
      "name": "Maria Silva",
      "email": "maria@example.com",
      "document": {
        "type": "CPF",
        "number": "12345678909"
      },
      "phone": {
        "areaCode": "+55",
        "ddd": "11",
        "number": "912345678",
        "isMobile": true
      }
    },
    "business": {
      "id": "8b1d2f4e-5a6c-4e7f-9a0b-1c2d3e4f5a6b",
      "name": "Acme Courses"
    },
    "items": [
      {
        "id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
        "name": "Online course",
        "description": "Lifetime access to the course",
        "valueInCents": 4990,
        "amount": 1,
        "product": {
          "id": "1e2f3a4b-5c6d-4e7f-8a9b-0c1d2e3f4a5b",
          "name": "Online course"
        },
        "offer": {
          "id": "9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d",
          "name": "Standard"
        },
        "paymentLink": {
          "id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
          "name": "Online course checkout"
        },
        "participants": [
          {
            "business": {
              "id": "8b1d2f4e-5a6c-4e7f-9a0b-1c2d3e4f5a6b",
              "name": "Acme Courses"
            }
          }
        ]
      }
    ],
    "payments": [
      {
        "id": "7d6c5b4a-3f2e-4d1c-8b0a-9f8e7d6c5b4a",
        "paymentMethod": "credit-card",
        "status": "paid",
        "valueInCents": 4990,
        "valuePaidInCents": 4990,
        "fineValueInCents": 0,
        "interestValueInCents": 0,
        "installments": 1,
        "creditCard": {
          "last4Numbers": "1111",
          "flag": "visa",
          "expiresAtMonth": 12,
          "expiresAtYear": 2032,
          "holderName": "MARIA SILVA"
        },
        "bankBillet": {
          "barCode": null,
          "expireAt": null,
          "line": null,
          "link": null
        },
        "pix": {
          "copyAndPasteCode": null,
          "expireAt": null,
          "qrCode": null
        }
      }
    ]
  }
}

Events7

order.created
order.updated
order.paid
order.partiallyPaid
order.canceled
order.refunded
order.chargeback

Easyflow sends an HTTP request with this payload to the URL registered for your webhook.

Payloadrequired

Webhook payload received by your server in the event of an event.

Content typeapplication/jsonobject

eventstring
Name of the event received.

Possible values:order.createdorder.updatedorder.paidorder.partiallyPaidorder.canceledorder.refundedorder.chargeback
occurredAtstring · date-time
Date and time when the notification was sent, in UTC.
payloadobject
Complete event data.
Show child attributesHide child attributes
- idstring · uuid
- createdAtstring · date-time
- updatedAtstring · date-time
- statusstring
  Possible values:pendingawating-paymentpaidpartially-paidcanceledreversedrefundedcharged-back
- paidAtstring · date-timenullable
  Date and time when the order was paid.
- valueInCentsinteger
  Sum of the unit value times the quantity of every item of the whole order, including the items of other businesses that are not in items.
- taxInCentsinteger
  Sum of the taxInCents of every commission of the whole order, of all the businesses that receive a part of it, not only of the business of this notification.
- netValueInCentsinteger
  Sum of the netValueInCents of every commission of the whole order, of all the businesses that receive a part of it, not only of the business of this notification.
- shippingobject
  Show child attributesHide child attributes
  valueInCentsinteger
- metadataarray of objects
  Key and value pairs saved with the order. Empty when the order has no metadata.
  Show child attributesHide child attributes
  keystring
  valuestring
- buyerobject
  Show child attributesHide child attributes
  namestring
  emailstring
  documentobject
  Show child attributesHide child attributes
  typestring
  numberstring
  phoneobject
  Show child attributesHide child attributes
  dddstring
  numberstring
  areaCodestring
  isMobileboolean
  addressobject
  Show child attributesHide child attributes
  streetstring
  neighborhoodstring
  numberstring
  citystring
  statestring
  zipCodestring
  complementstring
  deliveryAddressobject
  Show child attributesHide child attributes
  streetstring
  neighborhoodstring
  numberstring
  citystring
  statestring
  zipCodestring
  complementstring
- businessobject
  Business that receives this notification.
  Show child attributesHide child attributes
  idstring
  namestring
- couponobject
  Show child attributesHide child attributes
  codestringnullable
  discountobjectnullable
  Show child attributesHide child attributes
  percentagenumber
  valueInCentsinteger
  discountedValueInCentsinteger
- itemsarray of objects
  Show child attributesHide child attributes
  idstring
  namestring
  descriptionstring
  valueInCentsinteger
  Unit value of the item.
  
  amountinteger
  Quantity of the item.
  
  productobject
  Show child attributesHide child attributes
  idstring
  namestring
  offerobject
  Show child attributesHide child attributes
  idstring
  namestring
  paymentLinkobject
  Show child attributesHide child attributes
  idstring
  namestring
  participantsarray of objects
  Show child attributesHide child attributes
  businessobject
  Show child attributesHide child attributes
  idstring
  namestring
- paymentsarray of objects
  Payments of the order. In order events, pix, bankBillet and creditCard always come as objects, also for the methods that the payment did not use. The object of a method that was not used comes with all its fields null.
  Show child attributesHide child attributes
  idstring
  paymentMethodstring
  Payment method, such as credit-card, pix or bank-billet.
  
  statusstring
  Possible values:pendingin-processingauthorizedpaidpartially-paidrefusedabortedcanceledcharged-backchargeback-in-disputeunpaidaccepteddeniedreversedrefunded
  valueInCentsinteger
  valuePaidInCentsinteger
  fineValueInCentsinteger
  interestValueInCentsinteger
  installmentsinteger
  pixobjectnullable
  Show child attributesHide child attributes
  copyAndPasteCodestringnullable
  qrCodestringnullable
  expireAtstring · date-timenullable
  bankBilletobjectnullable
  Show child attributesHide child attributes
  expireAtstring · date-timenullable
  barCodestringnullable
  linkstringnullable
  linestringnullable
  creditCardobjectnullable
  Show child attributesHide child attributes
  last4Numbersstring
  flagstring
  Possible values:visamastercardamerican-expressdiners-clubdiscoverjcbunionpaymaestromirelohiperhipercard
  expiresAtYearinteger
  expiresAtMonthinteger
  holderNamestring
  nicknamestring
  refuseobjectnullable
  Reason why the payment was refused.
  
  Show child attributesHide child attributes
  rawDescriptionstring
  typestringnullable