Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.apifycloud.io/llms.txt

Use this file to discover all available pages before exploring further.

The platform supports a set of reminder kinds, each tied to a point in the booking lifecycle. You choose which ones to enable for each scheduling preset — reminders are not forced on. A preset can turn on any subset (only a 1h nudge, invitation + 15m, everything at once) and leave the rest off. Each kind you enable is also wired to one or more channels (e.g. WhatsApp), so you control both what fires and how it’s delivered.

The reminder kinds

KindWhen it firesPurpose
invitationOn bookingConfirms the booking to the customer with the join link.
reminder_24h24 hours before”Your meeting is tomorrow.”
reminder_1h1 hour before”Your meeting is in 1 hour.”
reminder_15m15 minutes beforeFinal nudge with the join link.
cancellationOn cancelNotifies the customer the booking was cancelled.
conflict_noticeWhen an agent creates a DND window that overlaps existing bookingsLets affected customers reschedule.
customOn demandAd-hoc reminder triggered manually or by the API.
A kind that isn’t enabled in the preset is simply never fired — no row is created, nothing is sent, nothing is logged.

Channels

Each reminder kind can be wired to one or more channels. Supported channels today:
  • WhatsApp — the primary channel. Uses an approved WhatsApp template configured in the preset.
  • Genesys Cloud — the pre-meeting dispatch to Genesys described in Genesys Cloud integration.

Templates and WhatsApp app linking

A video app doesn’t have its own WhatsApp number or template library. To send WhatsApp reminders, the video app is linked to a WhatsApp app — a separate app in the console that holds the number, the provider configuration, and the approved templates. Reminders are sent from that linked app’s number, using its templates. The flow:
  1. Configure the WhatsApp app with its number and approved templates (see WhatsApp — Templates).
  2. Link that WhatsApp app to the video app.
  3. In the video app’s scheduling preset, map each reminder kind to the template to use from the linked app’s library.
Templates must have the right variables for scheduling to fill in — guest name, scheduled date/time, and the join link are the common ones. The mapping is done per language if you support multiple locales.
A video app without a linked WhatsApp app can’t send WhatsApp reminders. The reminder kinds still exist and fire on the lifecycle, but the WhatsApp channel is unavailable until the link is in place.

Rescheduling and cancellation behavior

When a booking is rescheduled, the engine:
  1. Cancels any pending reminders for the old time.
  2. Re-plans the reminder schedule against the new time.
When a booking is cancelled, all pending reminders are cancelled. If the preset has the cancellation reminder enabled, that one fires.

Retries

Reminders that fail to send (temporary network issue, rate-limit on the provider, etc.) are retried automatically. After a few failed attempts the reminder is marked as failed and logged on the booking’s timeline so an operator can see it.
The retry cadence and limits are operational details handled by the platform — you don’t configure them per preset. If a reminder consistently fails it shows up on the booking’s timeline and in the admin UI for follow-up.

Manual reminders

From the booking detail page (or via the API) you can trigger an ad-hoc reminder at any time. It uses the custom kind and whichever channel you pick. Useful when an agent wants to nudge a customer right now rather than wait for the next scheduled reminder.

What’s next

Genesys Cloud integration

The Genesys Cloud reminder and pre-meeting dispatch.

Webhooks

Lifecycle events pushed to your systems.

Send a reminder via API

Trigger a reminder programmatically.