POST

Appointment Created Trigger

Fires when a new appointment is booked.

POSThttps://api.vantaxai.com/v1/workflows (trigger: appointment.created)

Use the `appointment.created` trigger to automate reminders, confirmations, and prep work whenever an appointment is scheduled. Scope it to a specific `calendar_id` so each calendar can have its own follow-up logic. When the event fires, the Workflow's `trigger_event` carries the appointment payload below. Reference this trigger by setting `trigger.type` to `appointment.created` 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 `appointment.created` to use this trigger.
example: appointment.created
trigger.config.calendar_idstringoptional
Only fire for appointments booked on this calendar.
example: cal_22f9

Request

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

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

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

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// POST /v1/workflows (trigger: appointment.created)
const result = await vantax.request("POST", "/v1/workflows (trigger: appointment.created)", {
  "trigger.type": "appointment.created",
  "trigger.config.calendar_id": "cal_22f9"
});

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# POST /v1/workflows (trigger: appointment.created)
result = vantax.request("POST", "/v1/workflows (trigger: appointment.created)", json={"trigger.type": "appointment.created", "trigger.config.calendar_id": "cal_22f9"})

Response

{
  "type": "appointment.created",
  "occurred_at": "2026-02-02T09:30:00Z",
  "sub_account_id": "sub_8a1f4c2e",
  "data": {
    "appointment_id": "appt_6d33b1",
    "calendar_id": "cal_22f9",
    "contact_id": "ct_91ad22",
    "title": "Intro Call",
    "start_time": "2026-02-05T15:00:00Z",
    "end_time": "2026-02-05T15:30:00Z",
    "status": "confirmed"
  }
}

{
  "success": false,
  "message": "Validation failed",
  "errors": [
    { "field": "trigger.config.calendar_id", "message": "calendar_id must reference a calendar in this sub-account" }
  ]
}