Skip to main content
POST
/
api
/
v1
/
chat
/
message
{
  "chatNodeId": "chat_node_id_1",
  "workflowExecutionId": "123e4567-e89b-12d3-a456-426614174000",
  "subject": "Your Order Update",
  "body": "Hello! We have an update on your order #12345. Please reply with your preferred delivery time.",
  "threadId": "email_thread_id_1"
}
​
Authorization
string
required
Bearer token for API authentication. Format: Bearer {{apiToken}}

​
Request Body

{
  "chatNodeId": "<chat_node_id>",
  "workflowExecutionId": "<workflow_execution_id>", 
  "body": "<slack_body>",
  "buttons": [
    {
      "text": "<button_text_1>",
      "value": "<button_value_1>",
      "style": "<button_style_1>"
    },
   {
      "text": "<button_text_1>",
      "value": "<button_value_1>",
      "style": "<button_style_1>"
    } 
  ],
  "threadId": "<thread_id>"
}

​
Body Parameters

​
template
object
Template configuration for the message
​
templateVariables
object
Key-value pairs to populate template placeholders
​
providerIntegration
object
Provider configuration
​
subject
string
Message subject (for EMAIL only)
​
body
string
Message body (for SLACK, EMAIL, TEAMS)
​
buttons
array
Interactive buttons (for SLACK only)
{
  "chatNodeId": "chat_node_id_1",
  "workflowExecutionId": "123e4567-e89b-12d3-a456-426614174000",
  "subject": "Your Order Update",
  "body": "Hello! We have an update on your order #12345. Please reply with your preferred delivery time.",
  "threadId": "email_thread_id_1"
}

​
Response

Success Response (200 OK)
  • The API returns an empty response body with HTTP status 200 when the chat message is successfully queued for processing.

​
Status Codes

  • 200 - OK
  • 400 - BAD REQUEST
  • 401 - UNAUTHORISED
  • 404 - NOT FOUND