Skip to main content

​
POST /api/fire-webhook

Fires an HTTP POST to an external URL with the conversation transcript. Called by the agent runtime when a Webhook node is reached during a conversation.

​
Request

{
  "url": "https://example.com/webhook",
  "conversation": [
    {
      "type": "user",
      "text": "I need help with my bill",
      "timestamp": "2025-01-01T12:00:00.000Z"
    },
    {
      "type": "assistant",
      "text": "I can help with that.",
      "timestamp": "2025-01-01T12:00:01.000Z"
    }
  ]
}
FieldTypeRequiredDescription
urlstring✅The external webhook URL to POST to
conversationarray✅Conversation transcript

​
Response

{
  "status": 200,
  "ok": true
}
FieldTypeDescription
statusnumberHTTP status code returned by the external URL
okbooleanWhether the request succeeded (status 2xx)

​
Error responses

StatusDescription
400Invalid or missing URL
500Network error or unexpected failure