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

AI Agent Execution Webhooks

Peach can trigger various webhooks as part of the AI agent's execution life-cycle, if those have been configured from within Peach — be it when an AI Agent converses with a contact, or when a conversation is analyzed.
1.
ai_flow_execution.started - this is triggered when the AI Agent picks up a conversation with a contact.
The webhook payload:
{
  "type": "ai_flow_execution.started",
  "data": {
    "id": "aiflw_1234abcd",
    "name": "Customer engagement",
    "app_type": "AI App",
    "status": "<one of draft or published>",
    "description": "Engages and solves customer queries."
  }
}
2.
ai_flow_execution.escalated - this is triggered when AI Agent escalates the conversation happening with a contact.
The webhook payload:
{
  "type": "ai_flow_execution.escalated",
  "data": {
    "id": "aiflw_1234abcd",
    "name": "Customer engagement",
    "app_type": "AI App",
    "status": "<one of draft or published>",
    "description": "Engages and solves customer queries."
  }
}
3.
ai_flow_execution.completed - this is triggered when AI Agent completes the conversation happening with a contact.
The webhook payload:
{
  "type": "ai_flow_execution.completed",
  "data": {
    "id": "aiflw_1234abcd",
    "name": "Customer engagement",
    "app_type": "AI App",
    "status": "<one of draft or published>",
    "description": "Engages and solves customer queries."
  }
}
4.
ai_flow_execution.analyzed - this is triggered when an AI Agent conversation is analyzed.
The webhook payload:
{
  "type": "ai_flow_execution.analyzed",
  "data": {
    "id": "aiflw_1234abcd",
    "name": "Customer engagement",
    "app_type": "AI App",
    "status": "<one of draft or published>",
    "description": "Engages and solves customer queries."
  }
}
Modified at 2026-04-21 12:14:01
Previous
Message delivery status webhooks
Next
WhatsApp Template
Built with