Configure access
Configure the communication provider in the venue’s Guests communication settings. The provider ID and issued webhook secret identify the inbound channel. This protocol is for a configured messaging connector, not general guest-record access.
Cabinet route: /venues/:venueId/guests → Settings → Providers. Required permission: guests.providers.manage. Keep the selected provider active and copy its issued webhook secret once.
First successful workflow
Follow these steps in order. Open each method for its exact body, required headers and response schema.
- For inbound messages, send provider event/message identities, source contact, body and occurrence time.
- For outbound delivery events, send the referenced provider message identity and delivery state.
- Sign timestamp + "." + JSON.stringify(parsed DTO) with UTF-8 secret and base64url output. Read whether the event was newly applied or replayed.
State, retries and recovery
Provider event/message identities control deduplication. Repeating a signature alone is not a universal replay failure for this profile. Delivery updates preserve previous attempts; unknown referenced messages require reconciliation.