Skip to main content
This page documents the payload structure for each webhook event type.

booking_created

Triggered when a new appointment is booked.

Payload

Key Fields

Series bookings

A recurring or multi-slot booking sends one booking_created event for its first session. recurringSeries lists every session, so iterate over recurringSeries.appointments to handle each one. Each session is its own appointment, so the ics field covers that session only. To read the series later, call Get public appointment details with the appointment id and its secret. On a group booking, pass the booker’s attendee id (newAttendee.id) as secret instead, since the series belongs to that seat.

booking_cancelled

Triggered when an appointment is cancelled by the host or attendee. For group bookings, this also fires when a single attendee cancels their spot — in that case isCancelled is false (the appointment remains active for other attendees) but the cancel object is still populated.

Payload

Key Fields

booking_rescheduled

Triggered when an appointment is moved to a new time.

Payload

Key Fields

new_employee

Triggered when a new user is added to your company.

Payload

Key Fields

form_submission

Triggered when someone submits a routing form or funnel.

Payload

Key Fields

signature_completed

Triggered when an e-signature request is fully signed (see E-Signatures).

Payload

Key Fields

transcript_received

Triggered once per booking, when its first transcript or summary lands: from the AI notetaker, a meetergo Connect recording, or a service writing PATCH /v4/appointment/{id}/transcription. The summary usually follows a minute after the transcript; read it with GET /v4/appointment/{id} (or the MCP tool get_meeting_transcript).

Payload

The booking, as in booking_created, plus:

Key Fields

whatsapp_message_received

Triggered when an inbound WhatsApp message arrives on a connected number (see WhatsApp). Reply by calling POST /v4/whatsapp/messages with the from number.

Payload

Key Fields

Because the contact just messaged you, the 24-hour customer-service window is open — a free-form text reply is allowed. See the WhatsApp 24h window.

whatsapp_message_sent

Triggered for every message sent in a WhatsApp conversation: written in the meetergo inbox or app, sent through the API, sent by Mira, or sent from the WhatsApp Business app on the phone (coexistence numbers). Together with whatsapp_message_received it keeps a conversation record complete without polling. Booking reminders and workflow templates are not conversation messages and do not fire it. Delivery progress for the same waMessageId follows as whatsapp_message_status.

Payload

Key Fields

Media is not embedded. For image, document or audio, fetch the attachment via GET /v4/whatsapp/conversations/{conversationId}/messages. Reactions do not fire this event.

whatsapp_message_status

Triggered when an outbound message’s delivery status changes (sent → delivered → read, or failed). Correlate with the waMessageId returned from POST /v4/whatsapp/messages.

Payload

Key Fields

Only real status upgrades fire (e.g. you won’t get a duplicate delivered). A failed status includes errorCode/errorMessage — a common one is the recipient being outside the 24-hour window for a non-template message.

Client portal events

Five events follow what a visitor does inside a client portal: space_viewed, space_invite_accepted, space_task_completed, space_task_reopened, space_file_uploaded. They share one head, so a receiver can attribute every event without a follow-up request.

Common fields

space_task_completed / space_task_reopened

Triggered when a verified viewer checks off an action-plan step, or unchecks one they had completed.

space_file_uploaded

Triggered when a viewer uploads a file to the portal’s upload zone. Files attached to a form answer arrive with form_submission instead.
GET {downloadPath} with your token returns a short-lived download URL.

space_viewed

Triggered when a visitor opens the portal, once per session. Owner previews do not fire it. Adds linkId and viewId.

space_invite_accepted

Triggered the first time an invited person opens the portal with a verified email (invite link or one-time code). Fires once per invite. Adds inviteId, linkId and viewId.

Common Attendee Fields

All booking events include attendee information:

Common Host Fields

All booking events include host information: All times in booking events are UTC. Convert them with the attendee’s or host’s timezone.

Handling Events

Example: Sync to CRM

Example: Send Slack Notification

Example: Correlate with External Ticket

Use metadata to link bookings back to external systems (e.g., CRM tickets, support cases):
The metadata field is set when creating the meeting type and is included in all booking webhooks. Use it to correlate bookings with your external systems.