Scheduling
Books a slot on a calendar the builder already owns: Cal.com, Calendly, a Meet room. Needs their booking link. If you do not have one, use `date` instead and ask them for a time directly.
schedulingBooks a slot on a calendar the builder already owns: Cal.com, Calendly, a Meet room. Needs their booking link. If you do not have one, use date instead and ask them for a time directly.
How it gets answered — arrives out of band (an upload, a payment, or a booking).
Configuration
Fields specific to scheduling. The fields every block has — id, ref, title, required, visibility, media, agentHints, prefillParam, identityField — are documented once.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"buttonLabel": {
"type": "string",
"maxLength": 60
},
"type": {
"type": "string",
"const": "scheduling"
},
"provider": {
"default": "external",
"type": "string",
"const": "external"
},
"url": {
"default": "",
"type": "string",
"maxLength": 500,
"format": "uri"
}
},
"required": [
"id",
"ref",
"title",
"type"
],
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"and",
"or"
]
},
"conditions": {
"default": [],
"type": "array",
"items": {
"type": "object",
"properties": {
"left": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "ref"
},
"ref": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{1,40}$"
}
},
"required": [
"kind",
"ref"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "variable"
},
"name": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,40}$"
}
},
"required": [
"kind",
"name"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "hidden"
},
"name": {
"type": "string",
"pattern": "^[a-zA-Z_][a-zA-Z0-9_.-]{0,60}$"
}
},
"required": [
"kind",
"name"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "literal"
}
},
"required": [
"kind"
]
}
]
},
"op": {
"type": "string",
"enum": [
"eq",
"neq",
"gt",
"gte",
"lt",
"lte",
"contains",
"not_contains",
"starts_with",
"ends_with",
"matches_regex",
"is_empty",
"is_not_empty",
"is_checked",
"is_not_checked",
"includes",
"not_includes",
"ranked_above",
"ranked_below"
]
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"required": [
"left",
"op"
]
}
},
"groups": {
"default": [],
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"op"
]
}
}
}In a generated draft these arrive as config pairs: url=<booking link>, required; without it this becomes a date question.
What you receive
GET /v1/forms/{id} and every "next question" projects blocks through toPublicBlock. For the example above:
{
"id": "blk_sched001",
"ref": "q_call",
"type": "scheduling",
"title": "Book a call",
"required": true,
"imageKey": null,
"media": null,
"url": "https://cal.com/acme/30min"
}What you send
The booking the respondent made on your calendar provider.
type Answer = { provider: string; url: string; slotIso?: string; confirmedAt?: number };curl -X POST https://api.chatform.in/v1/responses/{RESPONSE_ID}/answers \
-H "x-api-key: $CHATFORM_SECRET_KEY" \
-H "content-type: application/json" \
-d '{"ref": "q_call", "value": {"provider":"external","url":"https://cal.com/acme/30min","slotIso":"2026-06-01T10:00:00Z"}}'What gets stored
The value is normalised before it is saved, so what you read back is not always what you sent.
| You send | Stored | |
|---|---|---|
{"provider":"external","url":"https://cal.com/acme/30min","slotIso":"2026-06-01T10:00:00Z"} | {"provider":"external","url":"https://cal.com/acme/30min","slotIso":"2026-06-01T10:00:00Z"} |
Errors
| Code | When | Message |
|---|---|---|
required | an empty answer on a required block | This question needs an answer. |
type | {"provider":"external"} | Please book a time slot. |
Payment
Takes money. Use this whenever the request mentions a price, a fee, a ticket, a deposit or a UPI id, and never a text question asking them to confirm they paid. When the author has a payment account connected, a payment with no link or UPI id is taken through verified checkout on it, so give the amount and leave the link out unless one was named.
Field group
A small form asked once per person or item, repeated as many times as needed: two to five team members each with a name and an email, guests on a booking, line items on an order. Use this whenever the request describes the SAME set of details collected several times over; never a numbered run of separate questions ("Member 1 name", "Member 2 name"), which cannot stretch to a team of six or shrink to a team of two.