Answers, internal values, the priority, the tags, the due time or the pin of a submission changed, a file was added to it by a team member or the API, or the submitter of a web submission proved their number.
data
- e.g.
4182 -
The short code the submitter sees: the form's prefix and 6 characters. Every route that takes a submission id takes it too.
e.g.MR-7Q3M2A -
The form it was made with.
- channel string
whatsapp: the WhatsApp form. web: the web page. api: POST /submit/submissions. staff: entered by a team member.
whatsappwebapistaff -
The key of the stage it is in (the form's stages).
e.g.received - status_name stringe.g.
Received - status_kind string
opendonecancelled - status_color string
greybluegreenamberredpurple - priority string
lownormalhighurgent - due string (date-time) | null
The due time, or null.
- assignee object | null
The member it is assigned to, or null.
-
5 fields
- identity string
The submitter's WhatsApp number (digits, country code first) or business-scoped user id. Empty for a web submission with only an e-mail address.
e.g.61412345678 - name string
- phone string
- email string
- verified boolean
true: the number is proven (sent on WhatsApp, or confirmed from the web page with one message).
- conversation_id integer
The WhatsApp conversation. 0 when there is none.
-
What was asked: field key -> value. The value's JSON type follows the field type (text: string, number and rating: number, yesno and consent: boolean, multiselect: array of choice ids, photo and document: array of file ids, date: YYYY-MM-DD, location: the address text).
-
Everything that was not asked: internal fields, calculated values and values automations saved.
- location object | null
The pin the submitter sent, or null.
- parent string | null
The reference of the submission this one adds to (a follow-up form), or null.
- summary string
One line for lists: the first answers.
- files_count integer
- files_pending integer
Files of the WhatsApp form that are still being fetched. 0 = all stored.
- unread boolean
New, or the submitter added something staff have not opened yet.
- link string
The submitter's own page: status, history, add information. No login; treat it as a secret of the submitter.
- created string (date-time)
- updated string (date-time)
- status_changed string (date-time)
- closed string (date-time) | null
When it reached a done or cancelled stage, or null.
- deleted string (date-time)
Only on a deleted submission: when it was deleted.
- files object[]
One submission only (and webhook events).
9 item fields
- id integer
What a photo or document answer holds.
e.g.9917 - field string
The field it belongs to. Empty: added afterwards.
- name string
- mime string
- size integer
Bytes.
- state string
pending: still being fetched from WhatsApp. failed: could not be fetched.
pendingstoredfailed - source string
flow: the WhatsApp form. chat: sent in the chat afterwards.
flowwebchatstaffapi - url string
Fetches the file's bytes without a key. Valid for 7 days from this answer; read the submission again for a fresh one. Empty until the file is stored.
- created string (date-time)
-
What changed, one key per thing that changed, each with from and to; note = the note given with the change; by = who made it.
11 fields
- status object
Stage keys.
- assignee object
-
Key -> {from, to}, for every answer and internal value that changed.
-
The new pin {lat, lng, name, address}, or null when it was taken off.
- verified object
The submitter of a web submission proved their number with a WhatsApp message.
- priority object
- due object
- files object
File ids added by a team member or the API.
1 fields
- added integer[]
- note string
- by string
The member's name, API key <name>, or the automation's name.
Inside the envelope {id, type, created, number, test?, data}: envelope, headers, signature.
Caused by
- PATCH /v1/{number}/submit/submissions/{id} Change a submission: stage, assignee, tags, answers
- POST /v1/{number}/submit/submissions/{id}/files Attach a file to a submission
- POST /v1/{number}/submit/submissions/{id}/run Run a manual automation on a submission