1. webhooks
Peach
  • template-messages
    • Send a pre-approved template message
      POST
    • Poll template message status
      GET
    • Poll template messages status
      GET
    • Connect to AI Agent
      POST
    • Send an App message
      POST
  • broadcasts
    • List broadcasts
      GET
    • Launch a broadcast
      POST
    • Poll broadcast status
      GET
    • Get broadcast details
      GET
    • Archive broadcast
      PATCH
    • Cancel broadcast
      PATCH
  • whatsapp_templates
    • List all templates
      GET
    • Create a template
      POST
    • Update template
      PATCH
    • Archive template
      PATCH
    • Pause template
      PATCH
    • Submit template
      PATCH
    • Fetch template details
      GET
  • conversations
    • List messages
      GET
    • List conversations
      GET
    • Update conversation status
      PATCH
    • Agent Assignment
      POST
    • Close Conversation
      POST
  • contacts
    • Create multiple contacts
    • Update a contact
    • Create a contact
    • Bulk update communication preferences
  • orders
    • Create an order
    • Find order by ID
    • Create a refund for an order
  • medias
    • About uploaded media
    • List available medias
    • Add a media (Deprecated)
    • Remove a media
    • Create a direct upload for media
    • Finalize a direct uploaded media
  • webhooks
    • Order status webhooks
    • Flow execution status webhooks
    • Message delivery status webhooks
    • AI Agent Execution Webhooks
  • Schemas
    • Schemas
      • WhatsApp Template
      • WhatsApp Template Parameters
      • Order
      • RefundRequest
      • Contact
      • LineItem
      • OrderExpiry
      • TemplateMessage
      • AnyValue
      • Argument
      • Message
      • MessageResponse
  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"
    }
  }
}
Modified at 2026-04-21 12:14:01
Previous
Finalize a direct uploaded media
Next
Flow execution status webhooks
Built with