Talkify / Help / Payload builder
Free tool · No sign-up · Runs in your browser

Build the call payload.

Talkify's outgoing agents are started by a webhook: your CRM or automation tool posts a small piece of JSON at your trigger URL, and Talkify rings the person named in it and asks your questions. Write that JSON here, conditional follow-ups and all, then copy it straight into the webhook action.

Where the address comes from

Your trigger URL and signing secret come from your outgoing build in the agent builder. Deploy the build and copy them off the webhook trigger card. The URL looks like /api/webhooks/outbound/oc_... and never changes once it is minted, so you can paste it into a workflow and leave it there.

The secret travels as an X-Talkify-Secret header on every post. It is what tells us the call really came from you, so treat it like a password: it goes in the header, never in the body and never in a web address.

Nothing you type leaves this page

The builder is a piece of plain JavaScript running in your own browser. It makes no request to Talkify, saves nothing and sends nothing anywhere, so a real customer name, a real mobile number or a real signing secret can be pasted in while you get the shape right.

It does not place a call either. It writes the message that would, and hands it to you to paste into whichever system is going to do the posting.

The builder.

Fill in the left, copy from the right. Empty optional fields are left out of the JSON rather than sent as blanks, which is how the trigger expects them.

01Where it goes

Both optional here. Leave them blank and the example command uses placeholders in their place.

02Who we ring

The name is the one the agent says out loud, so put it in the form you would use on the phone.

03What the call is about

Write it as an instruction to the agent, in a sentence or two. This is the background the agent works from.

04What the agent says

Both optional. Leave them out and the agent uses the wording set on the build.

05The questions

Asked in the order they appear. Use the arrows to move one, and give a question a condition when it should only be asked sometimes.

06Tying it back

Comes back with the result, so you can match the answers to the right record. Left out, we fall back to the contact id.

Optional. A web address of yours that we post the answers and the transcript to when the call finishes.

Request body 
{}
Same thing as a command 
curl

Paste the command into a terminal to place one real call, or paste the JSON above into your automation tool's webhook action and set the two headers by hand.

Every key, and what it does.

The trigger checks the shape before it dials, so a payload that is wrong is refused rather than half rung. This is the whole list.

to
Required. The number to ring, in full international form such as +6421234567.
description
What the call is about, written as an instruction to the agent. Up to 5000 characters.
company_name
The business the agent says it is ringing from. Left out, your account name is used.
topic
A short label for the call, handy when one trigger covers several reasons to ring.
callback_ref
Your own reference, returned with the result. Left out, the contact id is used instead.
return_webhook
A web address of yours. When the call finishes, the answers and the transcript are posted there.
contact
An object holding id, name, email and phone. All optional, and all of it is for context rather than dialling: the number rung is the top level to.
agent
An object holding introduction and thank_you, the opening line and the sign off for this one call.
questions
Required, at least one, up to 25. Each is an object, described below.

Inside a question

key
Required. The short name the answer comes back under, so keep it stable once a workflow is reading it. Up to 64 characters.
prompt
Required. What the agent asks, in your own words. Up to 500 characters.
type
Required, one of open, yes_no or options.
required
True when the agent should keep at it until it has an answer, false when it can move on.
options
Required for the options type only. A list of objects, each with a value and an optional label.
condition_key
The key of an earlier question. Pointing forwards is refused, because the answer it depends on has not been given yet.
condition
Plain English for what that earlier answer had to mean, for example "they said the job is still outstanding". The agent judges the meaning of what was said rather than matching words. Set both keys or neither.

Conditions, in practice.

This is the part people get wrong by hand, and it is the reason this page exists.

Ask the obvious thing first

Start with a question everybody gets asked: "Is the hot water running properly now?" as a yes or no. Give it a key you will still recognise in six months, such as water_ok, because that is the name the answer arrives under in your CRM.

Then hang the follow up off it

The next question, "What is it doing?", points at water_ok and carries the condition "they said it is not working properly". On a call where the answer was yes, the agent simply never asks it, and the call is a quarter of the length.

i Conditions may only point backwards. Move a question above the one it depends on and the builder clears the condition rather than letting you save something the trigger would refuse. Delete a question and any condition pointing at it is cleared the same way.

Frequently asked.

The questions we hear most. If yours isn't here, ring our live demo agent on 03 242 1262, it'll either answer or queue a callback from a human.

Where do I get the trigger URL and the signing secret?
From your outgoing build in the agent builder. Deploy the build to mint them, then copy both off the webhook trigger card. Until a build is deployed there is no URL to post to, so the trigger card shows nothing to copy.
Is anything I type here sent to Talkify?
No. The builder runs entirely in your own browser. There is no request to us and nothing is stored, which is why it is safe to paste a real customer name, a real number or a real signing secret while you work.
How do conditional questions work?
A question can name an earlier question and a plain English description of what that earlier answer meant, for example "they said the job is urgent". The agent judges the meaning of what was actually said rather than matching exact words, and skips the question when it does not apply. A condition may only ever point backwards, at a question that has already been asked.
How many questions can one call ask?
Up to 25 on a single trigger. Fewer is almost always better: a call that asks three things gets answered, and a call that asks fifteen gets hung up on.
What happens to the answers?
They are captured against the call and shown in your dashboard alongside the summary and the transcript. If the payload carries a return_webhook, the result is posted back there when the call finishes, and any connected system on the build receives it too.
Does the phone number need a country code?
Use the full international form, so +64 for New Zealand and +61 for Australia. A local number without the code usually still works, but the international form removes any doubt about which country a mobile belongs to.
FREE TOOL · NOTHING LEAVES YOUR BROWSER

Stuck on the shape?
Ring us.

Hear it yourself · our AI agent, 24/7 · ask it anything 03 242 1262 Sign up, sales & support · we'll set you up 0800 002 967
● No form● No card● Free to call● The demo line can sign you up too
Text our agent · 027 204 8827