POST

Message Received Trigger

Fires when an inbound message arrives in a conversation.

POSThttps://api.vantaxai.com/v1/workflows (trigger: message.received)

Use the `message.received` trigger to react to inbound SMS or chat messages — route to an Agent, auto-tag, or kick off a reply sequence. Scope it by `channel` to react only to SMS or web chat. When the event fires, the Workflow's `trigger_event` contains the message payload below. Reference this trigger by setting `trigger.type` to `message.received` on the Create Workflow endpoint.

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…
Content-Typestringrequired
Must be application/json for requests with a body.
example: application/json

Body Parameters

trigger.typestringrequired
Set to `message.received` to use this trigger.
example: message.received
trigger.config.channelstringoptional
Only fire for messages on this channel.
smschatwhatsapp
example: sms

Request

curl -X POST https://api.vantaxai.com/v1/workflows (trigger: message.received) \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{
  "trigger.type": "message.received",
  "trigger.config.channel": "sms"
}'

const res = await fetch(
  "https://api.vantaxai.com/v1/workflows (trigger: message.received)",
  {
  method: "POST",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "trigger.type": "message.received",
    "trigger.config.channel": "sms"
  }),
  }
);
const { data } = await res.json();

import { Vantax } from "@vantax/sdk";

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// POST /v1/workflows (trigger: message.received)
const result = await vantax.request("POST", "/v1/workflows (trigger: message.received)", {
  "trigger.type": "message.received",
  "trigger.config.channel": "sms"
});

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# POST /v1/workflows (trigger: message.received)
result = vantax.request("POST", "/v1/workflows (trigger: message.received)", json={"trigger.type": "message.received", "trigger.config.channel": "sms"})

Response

{
  "type": "message.received",
  "occurred_at": "2026-02-02T10:05:00Z",
  "sub_account_id": "sub_8a1f4c2e",
  "data": {
    "message_id": "msg_2f81c0",
    "conversation_id": "conv_71ad90",
    "contact_id": "ct_91ad22",
    "channel": "sms",
    "direction": "inbound",
    "body": "Yes, please book me for Thursday."
  }
}

{
  "success": false,
  "message": "Validation failed",
  "errors": [
    { "field": "trigger.config.channel", "message": "channel must be one of sms, chat, whatsapp" }
  ]
}