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

AI flow execution status webhooks

Peach can trigger various webhooks as part of the AI flow execution's 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."
  }
}
Previous
Message delivery status webhooks
Built with