Skip to main content

Documentation Index

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

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

The Comms API is for transactional email — ticket confirmations, registration receipts, custom invitations, “I lost my ticket” resends. You manage the templates and the receiving webhook endpoint; Qflow handles delivery, tracking, bounce / spam compliance, and retries via SendGrid.

​
URL pattern

All Comms endpoints are routed through APIM at: 
https://api.qflowhub.io/comms/v1/api/comms/<endpoint>
The atomic create-and-send pattern (where you trigger an email as part of guest creation) lives on the Check-in API endpoint: 
https://api.qflowhub.io/checkin/v1/api/guest
Every request requires both an OAuth bearer token AND an Ocp-Apim-Subscription-Key header — see Authentication. Comms endpoints additionally require allow-list access (contact support if you get 403 comms_api_not_enabled).

​
What it does

When you create attendees via the API, you can optionally trigger a templated email send in the same call. Or you can send to attendees that already exist (bulk-imported, created via another endpoint). Either way:
  • Substitutes merge tokens like {{firstname}}, {{event}}, {{barcode}} from real attendee/event data
  • Optionally attaches a PDF rendered from the same email body
  • Optionally sends from your own DKIM-signed domain
  • Tracks delivery, opens, bounces and other lifecycle events
  • POSTs signed webhooks to your configured URL for every event
  • Supports retry-safe idempotency

​
Two send patterns

Atomic

POST /api/guest with commsTemplateId — create attendee + queue send in one call.

Two-step

POST /api/comms/send — send to an attendee that already exists.

​
Optional features

PDF attachments

Set attachPdf: true on a template — every send attaches a PDF rendered from the email body.

Custom sending domain

Authenticate your own domain via SendGrid Domain Authentication.

​
Read in this order

1

Templates

Author the email content. See Templates.
2

Webhooks

Register a receiver URL and verify HMAC signatures. See Webhooks.
3

Sending

Trigger sends — atomic or two-step. See Sending.
4

(Optional) Custom domain

Authenticate your own sending domain. See Custom domain.
For request/response schemas + try-it, see the auto-generated API Reference.