Skip to Content
WebhooksEssential Data Fields

Essential Data Fields

When you POST to your agent’s webhook URL to trigger an outbound call, this is what the endpoint accepts.

Required

FieldTypeNotes
phonestringThe number to call. Include the country code β€” +14155550132.
namestringThe callee’s name. full_name or fullName are accepted instead.

Both fields are required. A request without a name is rejected with 400 Bad Request and the message name or full name is required.

Optional

FieldTypeNotes
full_namestringAlias for name β€” satisfies the name requirement
fullNamestringAlias for name β€” satisfies the name requirement
emailstringMust be a valid email address if supplied

The three name fields are interchangeable aliases β€” send whichever one your automation tool produces naturally. There’s no need to send more than one, but at least one of them must be present.

Example

{ "phone": "+14155550132", "name": "John Doe", "email": "john.doe@example.com" }

Any additional keys you send β€” company, notes, booking_ref, anything your automation produces β€” are stored with the call and passed to the agent as context for that call. Reference them in the prompt or welcome message as {company}, {notes}, and so on. Use single braces and plain word_characters: {{company}} and keys containing a hyphen or a dot are not substituted. If you need per-call variables plus your own metadata echoed back on the completion webhook, use the Calls API.

Using the name in your prompt

The name you send here can be referenced in the agent’s prompt and welcome message as a variable β€” see How to Write a High-Quality Prompt.

Phone number format

Always include the country code with a + prefix. See Phone Number Formatting.