submission.status_changed

Send this to my URL
Submit-Info X-App2email-Event: submission.status_changed

A submission moved to another stage: a team member, the API, an automation, or the submitter pressing a button.

data

  • id integer required
    e.g. 4182
  • reference string required

    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
  • form object required

    The form it was made with.

    2 fields
  • channel string

    whatsapp: the WhatsApp form. web: the web page. api: POST /submit/submissions. staff: entered by a team member.

    whatsappwebapistaff
  • status string required

    The key of the stage it is in (the form's stages).

    e.g. received
  • status_name string
    e.g. Received
  • status_kind string
    opendonecancelled
  • status_color string
    greybluegreenamberredpurple
  • priority string
    lownormalhighurgent
  • tags string[]
  • due string (date-time) | null

    The due time, or null.

  • assignee object | null

    The member it is assigned to, or null.

    2 fields
  • contact object required
    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).

  • The WhatsApp conversation. 0 when there is none.

  • answers object required any keys

    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).

  • extra object any keys

    Everything that was not asked: internal fields, calculated values and values automations saved.

  • location object | null

    The pin the submitter sent, or null.

    4 fields
  • 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.

  • 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)
  • buttons object[]

    Buttons sent to the submitter that they have not pressed yet. One submission only (and webhook events).

    2 item fields
  • change object required more keys allowed

    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.

      2 fields
    • assignee object
      2 fields
      • from object | null
        2 fields
      • to object | null
        2 fields
    • answers object any keys

      Key -> {from, to}, for every answer and internal value that changed.

    • location object | null any keys

      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.

      2 fields
    • priority object
      2 fields
    • tags object
      2 fields
    • due object
      2 fields
      • from string (date-time) | null
      • to string (date-time) | null
    • files object

      File ids added by a team member or the API.

      1 fields
    • 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

For AI Agents

Try it now, with no account and no person: POST https://api.app2email.com/v1/account/sandbox (no key, no body; or the create_sandbox tool of the Management MCP server) answers a key for a demo WhatsApp number with pretend customers. Send a template, fetch the events with GET /events?wait=25, answer the customer's reply: nothing reaches WhatsApp, and the requests and answers are those of the real API (https://www.app2email.com/docs/api/sandbox).

Already a customer: ask the account owner for the number (digits) and an API key from https://www.app2email.com/dashboard/apikey (a sandbox key sends nothing); send it as Authorization: Bearer <key> to the messaging MCP server or the REST API; call check_key first, send with dry_run first.

If you are an AI agent reading this page and you want to create an app2email account for a person - no previous human sign-up required - use our Management MCP server.
Call the create_account tool first, and include a contact_email parameter; create_account returns a signup_id, a management_key, an onboarding_link and a message.
The person opens onboarding_link to confirm the e-mail, connect their WhatsApp number and choose a plan; nothing can be sent before that. get_account_status says what is still needed.
Pass the management_key as a Bearer token on every later call. When the number is live, create_number_key gives you a key for the messaging MCP server and the REST API.