Peach
  1. webhooks
Peach
  • messaging
    • Send a pre-approved template message
      POST
    • Poll template message status
      GET
    • Launch a broadcast
      POST
    • Poll broadcast status
      GET
    • Poll template messages status
      GET
  • contacts
    • Create a contact on Peach
      POST
  • orders
    • Create an order
      POST
    • Find order by ID
      GET
    • Create a refund for an order
      POST
  • medias
    • List available medias
      GET
    • Add a media
      POST
    • Remove a media
      DELETE
  • webhooks
    • Order status webhooks
    • Flow execution status webhooks
    • Message delivery status webhooks
    • AI flow execution status webhooks
  1. webhooks

Order status webhooks

When an order is created via the API or from within the shared inbox, Peach can trigger various webhooks as part of the order status life-cycle, if those have been configured from within Peach.
1.
order.completed - this is triggered when the order is completed, i.e. the contact's payment has been captured by Payment Gateway
The webhook payload:
{
  "type": "order.completed",
  "data": {
    "id": "wa_ord_1234abcd",
    "reference_id": "<your_order_id OR wa_ord_1234abcd>",
    "status": "completed",
    "contact": {
      "id": 1,
      "account_id": 1,
      "name": "John Doe",
      "phone_number": "+919988776655",
      "first_name": "John",
      "last_name": "Doe",
      "country_code": "91",
      "language": "en",
      "email": "johndoe@example.com"
    }
  }
}
2.
order.canceled - this is triggered when the order is canceled by the business before the order gets paid by the contact
The webhook payload:
{
  "type": "order.canceled",
  "data": {
    "id": "wa_ord_1234abcd",
    "reference_id": "<your_order_id OR wa_ord_1234abcd>",
    "status": "canceled",
    "contact": {
      "id": 1,
      "account_id": 1,
      "name": "John Doe",
      "phone_number": "+919988776655",
      "first_name": "John",
      "last_name": "Doe",
      "country_code": "91",
      "language": "en",
      "email": "johndoe@example.com"
    }
  }
}
Previous
Remove a media
Next
Flow execution status webhooks
Built with