Skip to content

Workflow Details

Returns the detailed configuration of a specific workflow including message templates, knowledge base articles, filters, and discount rules.

NameTypeRequiredDescriptionDefault
workflowIdstringYesThe workflow ID from list_workflows
What messages does my Abandoned Cart flow send? What discount does it offer?
{
"id": "wf-001",
"name": "Abandoned Cart - Main",
"type": "checkout",
"isPaused": false,
"status": "active",
"startsAt": null,
"endsAt": null,
"delayMinutes": 60,
"goal": "recover",
"action": {
"type": "discount",
"discount": {
"type": "percentage",
"value": "10",
"duration": "24h"
},
"agentReply": {
"replyWithMessage": true,
"contactSupport": false,
"supportEmail": null
}
},
"messages": [
{
"type": "initial",
"template": "Hi {Contact Name}! We noticed you left some items in your cart at {Store Name}. Here's {Discount Amount} off: {Discount Code}\n\nComplete your order: {Checkout URL}"
}
],
"flowMessages": [],
"knowledgeBase": [
{
"id": "kb-001",
"title": "Shipping Policy",
"content": "We offer free shipping on orders over $50. Standard delivery takes 3-5 business days."
}
],
"filters": [
{
"id": "ff-001",
"filter": {
"id": "f-001",
"name": "Cart value > $30",
"rule": { "field": "cart_value", "operator": "gt", "value": 30 }
}
}
]
}
  • Message templates contain variable placeholders like {Contact Name}, {Discount Code}, and {Checkout URL} that are replaced with real values when sent
  • delayMinutes is how long the system waits after the triggering event before sending the first message
  • Knowledge base articles are context provided to the AI agent for answering customer questions
  • For workflow performance stats, use dashboard-stats with the workflowId filter instead