Workflows

Node types#

Step

One screen of the service: an introduction spoken by the persona, then ordered inputs. Inputs can be grouped into a short form.

Condition

Routes to different steps based on earlier answers, using and/or rule groups with operators such as equals, not equals, contains, greater than, less than and is empty.

API call

Calls your system with the answers collected so far and maps the response into variables.

End

Completes the service.

Prompts and labels can be written in Arabic, English or both; a flow's language is ar, en or bilingual. A flow is a draft until you activate it. When you generate media, the persona's intro, prompt and confirmation clips are rendered in its own voice.

Inputs#

Each input has an internal field name, a label, an optional placeholder and the prompt the persona speaks to ask for it. Input types:

• text
• number
• email
• phone
• date
• choice
• component
• otp

Validation rules#

Attach any number of rules to an input. Each rule can carry its own error message in Arabic and English, so people hear exactly what to fix. There are 34 rule types:

One-time passcodes#

An otp input verifies that the person controls a phone number or email address. Codes are 6 digits, expire after 5 minutes, allow 5 attempts and work once. Sends are limited to 5 per identifier and 100 per tenant in any 10 minutes; over the limit, the API returns 429 with a Retry-After header.

curl -X POST "https://avatar-api.syntiva.tech/otp/send" \
  -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"identifier": "+971501234567"}'

curl -X POST "https://avatar-api.syntiva.tech/otp/verify" \
  -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"identifier": "+971501234567", "code": "482913"}'

API call nodes#

methodstring

GET, POST, PUT, PATCH or DELETE.

urlstring

The endpoint to call.

headerskey/value[]

Values can use template variables such as {{step_1.field_name}}.

body, body_typestring

A templated body sent as json, form or text.

response_mappingsobject[]

JSON paths in the response saved as variables for later steps.

variable_namestring

Results are available as apiCall_{variable_name}.

continue_on_errorboolean

Keep going if the call fails, instead of stopping the flow.

timeout_msnumber

Optional timeout in milliseconds.

Webhooks#

When a submission completes or is abandoned, Servly POSTs it to the submission's webhook URL. Set the URL when you create a submission with POST /flows/{id}/submissions. It must use HTTPS and can't point at private or internal network addresses.

{
  "event": "flow.completed",
  "flow_id": "flw_7c2e…",
  "flow_name": "Renew trade licence",
  "submission_id": "sub_91ab…",
  "session_id": "4f0d…",
  "completed_at": "2026-10-04T10:42:17.000Z",
  "data": {
    "step_1": { "licence_number": "CN-1234567" },
    "step_2": { "emirates_id": "784-1990-1234567-1", "mobile": "+971501234567" }
  }
}

X-Webhook-Eventheader

flow.completed or flow.abandoned.

X-Submission-IDheader

The submission's ID.

dataobject

Collected answers, keyed by step and then by field name.

Retriespolicy

Up to 3 retries with backoff; each attempt times out after 30 seconds. The response is stored on the submission.

How the persona runs a flow#

1. It matches the request to a flow by name and trigger keywords, with Arabic spelling normalized.
2. It offers the service and waits for a yes. A bare “no” never cancels a service in progress.
3. It asks for each input, validates the answer, and asks again with the error message if it doesn't pass.
4. If someone asks a side question, it answers and then repeats the current step's prompt.
5. On completion it sends the webhook; if the person stops, the submission is recorded as abandoned.

Analytics#

Every flow, step, input, validation failure, retry and API call is tracked. In the console you get an overview, a per-step funnel (entries, completions, average time), per-input statistics, peak hours and trends, and you can export the data as CSV or JSON.