booking.cancelled

Send this to my URL
Book-and-Pay X-App2email-Event: booking.cancelled

An appointment was cancelled: by the customer (CANCEL on WhatsApp), the business, the API or app2email.

data

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

    The short code the customer sees. GET /bookings/{id} takes it too.

    e.g. BK-7Q3M2A
  • status string required
    confirmedcancelledcompletedno_show
  • contact string required

    The customer's number (digits, country code first) or their business-scoped user id.

    e.g. 61412345678
  • contact_name string
    e.g. John Smith
  • e.g. john@example.com
  • service object
    3 fields
  • start string (date-time) required

    UTC.

  • end string (date-time)

    UTC.

  • timezone string

    The business time zone the slot was chosen in.

    e.g. Australia/Sydney
  • source string

    Booked by the customer in WhatsApp, on the dashboard (or in the calendar app), through this API, or by the customer on the online booking page (web).

    whatsapp_flowdashboardapiweb
  • calendar object
    4 fields
    • provider string
      builtingooglemicrosoftcaldavics
    • event_id string
    • url string
    • error string

      The calendar write failed; the booking still stands.

  • answers object any keys

    Every other field the customer filled in the Flow.

  • notes string
  • provider object

    The staff member, when the business has them. Left out otherwise.

    2 fields
    • id string
      e.g. maria
    • name string
      e.g. Maria
  • rating integer

    The customer's rating from the follow-up message (5 loved it, 3 OK, 1 not great). Left out until given.

    135
  • The business's own note on the payment. Left out when none.

    link_sentpaidwaived
  • credits_used integer

    Always 0 (memberships were removed on 2026-11-10); kept so existing integrations keep parsing.

  • attendance_confirmed string (date-time)

    When the customer tapped Confirm on a reminder.

  • cancelled object

    Only when cancelled.

    3 fields
    • at string (date-time)
    • by string
      customerbusinessapisystem
    • reason string
  • The appointment this one replaced.

  • notes_count integer

    How many internal notes are written on this appointment (GET /bookings/{id}/notes). Given by the calendar routes and the list; left out of webhook events.

  • created string (date-time)
  • location object | null

    Where it takes place, as chosen (null: the service has no locations; then config.messages.location). value: the address, the number, the link; a video link made by the connected Google or Microsoft calendar appears here once made. text: how the messages show it.

    4 fields
    • kind string
      in_personphone_we_callphone_you_callvideocustomer_addresscustom
    • label string
    • value string
    • text string
  • addons object[]

    The add-ons booked (copied at booking time).

    4 item fields
  • guests object[]

    The people who come along.

    2 item fields
  • answer_items object[]

    The answers to the service's questions as label / value (the raw ones are in answers.q).

    3 item fields
  • series object | null

    This appointment is one of a series (null: not).

    4 fields
    • id string
      e.g. SR-7Q3M2A
    • index integer
    • count integer
    • freq string
      weeklybiweeklyevery4weeksmonthly
  • seats integer

    The places this booking takes on a group time (1 + guests); 1 otherwise.

  • timestamp string (date-time)

Inside the envelope {id, type, created, number, test?, data}: envelope, headers, signature.

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.