Events
Public listing (publishable key) and full event management (secret key). Recurring events carry recurring: true plus an occurrences array; attendees register per date via occurrenceId.
get/v1/eventspk_ or sk_
Publishable key: published events currently inside their publish window (recurring events with no upcoming dates drop out). Secret key: every event, with management fields. Pagination slices after visibility/category/tag filters, so offsets are stable against what the caller can see.
| Name | In | Type | |
|---|---|---|---|
lang | query | string | BCP-47 locale for localized labels/content (e.g. |
category | query | string | Filter by category slug. |
tag | query | string | Filter by tag slug. |
limit | query | integer | Page size. Omit (with offset) for the full list. |
offset | query | integer | Rows to skip. Page with |
200 | Event list with paging metadata. {
events: [ // optional
{
id: string
title: string
description: string // nullable · Plain-text card summary.
descriptionBlocks: [ // optional
{
id: string // required
type: "text" | "image" | "video" | "faq" | "lineup" | "agenda" // required
text: string
url: string
urls: string[]
alt: string // nullable
layout: "full" | "text-left" | "text-right"
provider: "youtube" | "vimeo"
videoId: string
items: object[]
}
]
location: string // nullable
startsAt: string // For recurring events, the NEXT upcoming date.
endsAt: string // nullable
capacity: integer // nullable · Recurring events: public value is the series total over upcoming dates.
spotsLeft: integer // nullable · null = unlimited. Reported as 0 while a waitlist queue holds freed spots.
category: string // nullable · Stable slug.
categoryLabel: string // nullable · Localized display label.
tags: string[] // Stable slugs.
tagLabels: [ // optional
{
slug: string
label: string
}
]
bannerUrl: string // nullable
thumbnailUrl: string // nullable
customFields: [ // optional
{
key: string // required
label: string // required
type: "text" | "textarea" | "email" | "phone" | "number" | "date" | "url" | "select" | "radio" | "multiselect" | "checkbox" // required
required: boolean
helpText: string // nullable
options: [ // optional
{
value: string
label: string
}
]
}
]
registrationStatus: "open" | "scheduled" | "closed" | "disabled"
registrationOpensAt: string // nullable
registrationClosesAt: string // nullable
waitlistOpen: boolean
recurring: boolean
nextOccurrenceAt: string // nullable
occurrences: [ // optional
{
id: string
startsAt: string
endsAt: string // nullable
capacity: integer // nullable · Per-date override; null = event default.
spotsLeft: integer // nullable
registrationStatus: "open" | "scheduled" | "closed" | "disabled"
waitlistOpen: boolean
status: "active" | "cancelled" // Management payloads only.
registrationCount: integer // Management payloads only.
}
]
organizer:
{
name: string // nullable
contactEmail: string // nullable
url: string // nullable
logo: string // nullable
}
shareUrl: string // nullable · Rich-share link (`/s/<eventId>`) once the company sets its events page URL.
timezone: string // nullable · IANA zone the event's wall-clock times are meant in (account-level). Datetimes stay UTC instants.
doorsOpenMins: integer // nullable
minAge: integer // nullable
parking: "free" | "paid" | "none" // nullable
captchaSiteKey: string // nullable · Tenant-configured bot-protection site key for `captchaProvider`. When present, browser registrations must include a verified captchaToken (the widget handles this automatically).
captchaProvider: "turnstile" | "recaptcha_v2" | "recaptcha_v3" // nullable · Which provider `captchaSiteKey` belongs to: Cloudflare Turnstile, Google reCAPTCHA v2 ("I’m not a robot" checkbox) or reCAPTCHA v3 (invisible; execute with action `register`). Null when bot protection is off.
}
]
total: integer
limit: integer // nullable
offset: integer
languages: string[] // The organizer's languages (BCP-47), default first.
} |
post/v1/eventssk_ only
{
title: string
description: string // nullable
descriptionBlocks: [ // optional
{
id: string // required
type: "text" | "image" | "video" | "faq" | "lineup" | "agenda" // required
text: string
url: string
urls: string[]
alt: string // nullable
layout: "full" | "text-left" | "text-right"
provider: "youtube" | "vimeo"
videoId: string
items: object[]
}
]
location: string // nullable
startsAt: string
endsAt: string // nullable
capacity: integer // nullable
category: string // nullable
tags: string[]
status: "draft" | "published" | "cancelled"
publishStartsAt: string // nullable
publishEndsAt: string // nullable
registrationEnabled: boolean
registrationOpensAt: string // nullable
registrationClosesAt: string // nullable
waitlistEnabled: boolean
waitlistLimit: integer // nullable
doorsOpenMins: integer // nullable
minAge: integer // nullable
parking: "free" | "paid" | "none" // nullable
organizerName: string // nullable
contactEmail: string // nullable
organizerUrl: string // nullable
organizerLogo: string // nullable
confirmationMessage: string // nullable · Per-event [event_message] paragraph in confirmation emails.
reminderMessage: string // nullable
customFields: [ // optional
{
key: string // required
label: string // required
type: "text" | "textarea" | "email" | "phone" | "number" | "date" | "url" | "select" | "radio" | "multiselect" | "checkbox" // required
required: boolean
helpText: string // nullable
options: [ // optional
{
value: string
label: string
}
]
}
]
occurrences: [ // optional
{
id: string
startsAt: string
endsAt: string // nullable
capacity: integer // nullable · Per-date override; null = event default.
spotsLeft: integer // nullable
registrationStatus: "open" | "scheduled" | "closed" | "disabled"
waitlistOpen: boolean
status: "active" | "cancelled" // Management payloads only.
registrationCount: integer // Management payloads only.
}
]
recurrence: string // nullable · Free-form pattern JSON the dashboard uses to regenerate the list.
translations: object
}
201 | Created. {
event:
{
id: string
title: string
description: string // nullable · Plain-text card summary.
descriptionBlocks: [ // optional
{
id: string // required
type: "text" | "image" | "video" | "faq" | "lineup" | "agenda" // required
text: string
url: string
urls: string[]
alt: string // nullable
layout: "full" | "text-left" | "text-right"
provider: "youtube" | "vimeo"
videoId: string
items: object[]
}
]
location: string // nullable
startsAt: string // For recurring events, the NEXT upcoming date.
endsAt: string // nullable
capacity: integer // nullable · Recurring events: public value is the series total over upcoming dates.
spotsLeft: integer // nullable · null = unlimited. Reported as 0 while a waitlist queue holds freed spots.
category: string // nullable · Stable slug.
categoryLabel: string // nullable · Localized display label.
tags: string[] // Stable slugs.
tagLabels: [ // optional
{
slug: string
label: string
}
]
bannerUrl: string // nullable
thumbnailUrl: string // nullable
customFields: [ // optional
{
key: string // required
label: string // required
type: "text" | "textarea" | "email" | "phone" | "number" | "date" | "url" | "select" | "radio" | "multiselect" | "checkbox" // required
required: boolean
helpText: string // nullable
options: [ // optional
{
value: string
label: string
}
]
}
]
registrationStatus: "open" | "scheduled" | "closed" | "disabled"
registrationOpensAt: string // nullable
registrationClosesAt: string // nullable
waitlistOpen: boolean
recurring: boolean
nextOccurrenceAt: string // nullable
occurrences: [ // optional
{
id: string
startsAt: string
endsAt: string // nullable
capacity: integer // nullable · Per-date override; null = event default.
spotsLeft: integer // nullable
registrationStatus: "open" | "scheduled" | "closed" | "disabled"
waitlistOpen: boolean
status: "active" | "cancelled" // Management payloads only.
registrationCount: integer // Management payloads only.
}
]
organizer:
{
name: string // nullable
contactEmail: string // nullable
url: string // nullable
logo: string // nullable
}
shareUrl: string // nullable · Rich-share link (`/s/<eventId>`) once the company sets its events page URL.
timezone: string // nullable · IANA zone the event's wall-clock times are meant in (account-level). Datetimes stay UTC instants.
doorsOpenMins: integer // nullable
minAge: integer // nullable
parking: "free" | "paid" | "none" // nullable
captchaSiteKey: string // nullable · Tenant-configured bot-protection site key for `captchaProvider`. When present, browser registrations must include a verified captchaToken (the widget handles this automatically).
captchaProvider: "turnstile" | "recaptcha_v2" | "recaptcha_v3" // nullable · Which provider `captchaSiteKey` belongs to: Cloudflare Turnstile, Google reCAPTCHA v2 ("I’m not a robot" checkbox) or reCAPTCHA v3 (invisible; execute with action `register`). Null when bot protection is off.
}
} |
409 | plan_limit / invalid_locale. {
error: string // required · Stable machine-readable code.
message: string // Human-readable; may change.
} |
get/v1/events/{id}pk_ or sk_
| Name | In | Type | |
|---|---|---|---|
id | path | string | |
lang | query | string | BCP-47 locale for localized labels/content (e.g. |
200 | The event. {
event:
{
id: string
title: string
description: string // nullable · Plain-text card summary.
descriptionBlocks: [ // optional
{
id: string // required
type: "text" | "image" | "video" | "faq" | "lineup" | "agenda" // required
text: string
url: string
urls: string[]
alt: string // nullable
layout: "full" | "text-left" | "text-right"
provider: "youtube" | "vimeo"
videoId: string
items: object[]
}
]
location: string // nullable
startsAt: string // For recurring events, the NEXT upcoming date.
endsAt: string // nullable
capacity: integer // nullable · Recurring events: public value is the series total over upcoming dates.
spotsLeft: integer // nullable · null = unlimited. Reported as 0 while a waitlist queue holds freed spots.
category: string // nullable · Stable slug.
categoryLabel: string // nullable · Localized display label.
tags: string[] // Stable slugs.
tagLabels: [ // optional
{
slug: string
label: string
}
]
bannerUrl: string // nullable
thumbnailUrl: string // nullable
customFields: [ // optional
{
key: string // required
label: string // required
type: "text" | "textarea" | "email" | "phone" | "number" | "date" | "url" | "select" | "radio" | "multiselect" | "checkbox" // required
required: boolean
helpText: string // nullable
options: [ // optional
{
value: string
label: string
}
]
}
]
registrationStatus: "open" | "scheduled" | "closed" | "disabled"
registrationOpensAt: string // nullable
registrationClosesAt: string // nullable
waitlistOpen: boolean
recurring: boolean
nextOccurrenceAt: string // nullable
occurrences: [ // optional
{
id: string
startsAt: string
endsAt: string // nullable
capacity: integer // nullable · Per-date override; null = event default.
spotsLeft: integer // nullable
registrationStatus: "open" | "scheduled" | "closed" | "disabled"
waitlistOpen: boolean
status: "active" | "cancelled" // Management payloads only.
registrationCount: integer // Management payloads only.
}
]
organizer:
{
name: string // nullable
contactEmail: string // nullable
url: string // nullable
logo: string // nullable
}
shareUrl: string // nullable · Rich-share link (`/s/<eventId>`) once the company sets its events page URL.
timezone: string // nullable · IANA zone the event's wall-clock times are meant in (account-level). Datetimes stay UTC instants.
doorsOpenMins: integer // nullable
minAge: integer // nullable
parking: "free" | "paid" | "none" // nullable
captchaSiteKey: string // nullable · Tenant-configured bot-protection site key for `captchaProvider`. When present, browser registrations must include a verified captchaToken (the widget handles this automatically).
captchaProvider: "turnstile" | "recaptcha_v2" | "recaptcha_v3" // nullable · Which provider `captchaSiteKey` belongs to: Cloudflare Turnstile, Google reCAPTCHA v2 ("I’m not a robot" checkbox) or reCAPTCHA v3 (invisible; execute with action `register`). Null when bot protection is off.
}
} |
404 | Not found, unpublished, or outside its publish window (publishable view). |
patch/v1/events/{id}sk_ only
Partial update; also flips status (draft → published ⇄ cancelled). Plan limits are enforced on publish and on custom-field counts (409 plan_limit). On paid plans, publishing also needs the account’s own SMTP set up and test-sent (409 smtp_required).
| Name | In | Type | |
|---|---|---|---|
id | path | string |
{
title: string
description: string // nullable
descriptionBlocks: [ // optional
{
id: string // required
type: "text" | "image" | "video" | "faq" | "lineup" | "agenda" // required
text: string
url: string
urls: string[]
alt: string // nullable
layout: "full" | "text-left" | "text-right"
provider: "youtube" | "vimeo"
videoId: string
items: object[]
}
]
location: string // nullable
startsAt: string
endsAt: string // nullable
capacity: integer // nullable
category: string // nullable
tags: string[]
status: "draft" | "published" | "cancelled"
publishStartsAt: string // nullable
publishEndsAt: string // nullable
registrationEnabled: boolean
registrationOpensAt: string // nullable
registrationClosesAt: string // nullable
waitlistEnabled: boolean
waitlistLimit: integer // nullable
doorsOpenMins: integer // nullable
minAge: integer // nullable
parking: "free" | "paid" | "none" // nullable
organizerName: string // nullable
contactEmail: string // nullable
organizerUrl: string // nullable
organizerLogo: string // nullable
confirmationMessage: string // nullable · Per-event [event_message] paragraph in confirmation emails.
reminderMessage: string // nullable
customFields: [ // optional
{
key: string // required
label: string // required
type: "text" | "textarea" | "email" | "phone" | "number" | "date" | "url" | "select" | "radio" | "multiselect" | "checkbox" // required
required: boolean
helpText: string // nullable
options: [ // optional
{
value: string
label: string
}
]
}
]
occurrences: [ // optional
{
id: string
startsAt: string
endsAt: string // nullable
capacity: integer // nullable · Per-date override; null = event default.
spotsLeft: integer // nullable
registrationStatus: "open" | "scheduled" | "closed" | "disabled"
waitlistOpen: boolean
status: "active" | "cancelled" // Management payloads only.
registrationCount: integer // Management payloads only.
}
]
recurrence: string // nullable · Free-form pattern JSON the dashboard uses to regenerate the list.
translations: object
}
200 | Updated event (management shape). |
409 | plan_limit / smtp_required / invalid_locale. {
error: string // required · Stable machine-readable code.
message: string // Human-readable; may change.
} |
delete/v1/events/{id}sk_ only
Blocked with 409 while registrations exist — cancel the event instead. Reclaims uploaded images.
| Name | In | Type | |
|---|---|---|---|
id | path | string |
204 | Deleted. |
409 | Has registrations. |
post/v1/events/{id}/viewspk_ or sk_
Fire-and-forget, PII-free per-day counter (the widget calls this when a visitor opens an event's detail). No body.
| Name | In | Type | |
|---|---|---|---|
id | path | string |
204 | Counted. |
Registrations & check-in
Registration submission is public (publishable key); attendee lists, cancel/reactivate/promote, and check-in need the secret key.
get/v1/events/{id}/registrationssk_ only
Contains PII — management only. Ordered oldest first.
| Name | In | Type | |
|---|---|---|---|
id | path | string | |
limit | query | integer | Page size. Omit (with offset) for the full list. |
offset | query | integer | Rows to skip. Page with |
status | query | confirmed | waitlisted | cancelled |
200 | Registrations with paging metadata. {
registrations: [ // optional
{
id: string
eventId: string
name: string
email: string
answers: object // nullable · Custom-field key → canonical option value(s); multiselect joins with ", "; checkbox stores "yes".
status: "confirmed" | "waitlisted" | "cancelled"
locale: string // nullable
occurrenceId: string // nullable
occurrenceStartsAt: string // nullable
ticketUrl: string // nullable · Hosted QR ticket page; the embedded token is the credential.
checkedInAt: string // nullable
createdAt: string
}
]
total: integer
limit: integer // nullable
offset: integer
} |
post/v1/events/{id}/registrationspk_ or sk_
Recurring events require occurrenceId (one registration per email per date). When the event/date is full but waitlistOpen is true, the same request succeeds with status: "waitlisted". Never send a website field — it is a bot honeypot.
| Name | In | Type | |
|---|---|---|---|
id | path | string |
{
name: string // required
email: string // required
locale: string // Language of the attendee's confirmation/reminder emails and ticket page.
occurrenceId: string // Required for recurring events.
answers: object // Custom-field key → canonical option value(s).
captchaToken: string // Bot-protection token from the event’s `captchaProvider` (Turnstile, or reCAPTCHA v2/v3 — for v3 executed with action `register`) — required for publishable-key requests when the event’s captchaSiteKey is set. Secret-key calls are never challenged.
}
201 | Registered (or waitlisted). {
registration:
{
id: string
eventId: string
name: string
email: string
answers: object // nullable · Custom-field key → canonical option value(s); multiselect joins with ", "; checkbox stores "yes".
status: "confirmed" | "waitlisted" | "cancelled"
locale: string // nullable
occurrenceId: string // nullable
occurrenceStartsAt: string // nullable
ticketUrl: string // nullable · Hosted QR ticket page; the embedded token is the credential.
checkedInAt: string // nullable
createdAt: string
}
} |
400 | invalid_request / invalid_answers (with per-field messages) / captcha_failed. |
409 | already_registered / sold_out / registration_closed / plan_limit / trial_expired / plan_expired (the trial or plan period has ended — registrations pause until a plan is chosen or renewed). |
post/v1/events/{id}/registrations/exportsk_ only
Real Office AES encryption; includes cancelled records and all custom-field columns. Password: ≥8 chars with a letter and a number.
| Name | In | Type | |
|---|---|---|---|
id | path | string |
{
password: string // required
}
200 | Encrypted .xlsx file. |
post/v1/registrations/{id}/cancelsk_ only
Frees the spot — but never auto-promotes: freed spots are held for the waitlist queue until you promote someone.
| Name | In | Type | |
|---|---|---|---|
id | path | string |
200 | Cancelled registration. |
post/v1/registrations/{id}/reactivatesk_ only
Capacity is re-checked — restore can't oversell (409 sold_out).
| Name | In | Type | |
|---|---|---|---|
id | path | string |
200 | Restored. |
409 | sold_out. |
post/v1/registrations/{id}/promotesk_ only
The ONLY way waitlisted becomes confirmed; the attendee gets the standard confirmation email with their ticket. Capacity re-checked.
| Name | In | Type | |
|---|---|---|---|
id | path | string |
200 | Promoted. |
409 | sold_out. |
post/v1/events/{id}/checkinsk_ only
The event is derived from the token server-side and cross-checked against the URL: wrong event → 409 with the ticket's real event name; duplicate scan → 409 with the original check-in time. Other tenants' tokens are indistinguishable from invalid ones.
| Name | In | Type | |
|---|---|---|---|
id | path | string |
{
token: string // required
}
200 | Checked in. |
409 | Wrong event or duplicate scan. |
post/v1/registrations/{id}/checkinsk_ only
| Name | In | Type | |
|---|---|---|---|
id | path | string |
200 | Checked in. |
post/v1/registrations/{id}/undo-checkinsk_ only
| Name | In | Type | |
|---|---|---|---|
id | path | string |
200 | Undone. |
Tickets
Token-authenticated — the ticket URL's token *is* the credential; no API key.
get/v1/tickets/{token}no auth
Attendee name, status, checkedInAt, locale, availableLocales, and the event (title/times/location localized, bannerUrl, organizer). Build custom ticket pages from this plus the QR endpoint.
| Name | In | Type | |
|---|---|---|---|
token | path | string | |
lang | query | string | BCP-47 locale for localized labels/content (e.g. |
200 | Ticket payload. |
404 | Unknown or erased token. |
get/v1/tickets/{token}/qr.svgno auth
Encodes the bare token — scannable by the check-in endpoint.
| Name | In | Type | |
|---|---|---|---|
token | path | string |
200 | SVG image. |
Categories & tags
Company categories (plus the platform's general set) and tags. Slugs are permanent; labels translate.
get/v1/categoriespk_ or sk_
Company categories plus the platform's general set. Management view adds full per-language label maps.
| Name | In | Type | |
|---|---|---|---|
lang | query | string | BCP-47 locale for localized labels/content (e.g. |
200 | Categories. {
categories: [ // optional
{
slug: string // Permanent identifier, derived from the default-language label at creation.
label: string // Localized for the requested `lang`.
labels: object // Full per-language map (management view).
}
]
} |
post/v1/categoriessk_ only
{
labels: object
}
201 | Created; slug derives from the default-language label and never changes. |
put/v1/categories/{slug}sk_ only
| Name | In | Type | |
|---|---|---|---|
slug | path | string |
{
labels: object
}
200 | Updated; slug stable. |
get/v1/tagspk_ or sk_
| Name | In | Type | |
|---|---|---|---|
lang | query | string | BCP-47 locale for localized labels/content (e.g. |
200 | Tags (same model as categories, company-scoped only). |
post/v1/tagssk_ only
201 | Created. |
put/v1/tags/{slug}sk_ only
| Name | In | Type | |
|---|---|---|---|
slug | path | string |
200 | Updated. |
Images
Raw-body uploads — JPEG/PNG/WebP up to 10 MB, validated by magic bytes.
put/v1/events/{id}/images/{kind}sk_ only
Raw image body (JPEG/PNG/WebP, up to 10 MB, magic-byte validated). Banner is 3:1 (1500×500 recommended), thumbnail square (600×600). Replacing reclaims the old file.
| Name | In | Type | |
|---|---|---|---|
id | path | string | |
kind | path | banner | thumbnail |
200 | Stored; returns the event with the new URL. |
delete/v1/events/{id}/images/{kind}sk_ only
| Name | In | Type | |
|---|---|---|---|
id | path | string | |
kind | path | banner | thumbnail |
200 | Removed. |
post/v1/images/descriptionsk_ only
Raw image body → { "url": "/uploads/…" } for use in description blocks, lineup photos, or per-event organizer logos. Uploads nothing ends up referencing are swept after ~24h.
200 |
|
Broadcasts
"Message attendees" — paid plans, metered by monthly recipient-message quota.
post/v1/events/{id}/broadcastsk_ only
Shortcodes render per recipient in the language each attendee registered in. 409 plan_limit when the plan lacks the feature or the monthly recipient-message quota can't cover the send.
| Name | In | Type | |
|---|---|---|---|
id | path | string |
{
subject: string // required
message: string // required
}
200 | Send accepted; history records per-recipient status. |
409 | plan_limit. |
post/v1/events/{id}/broadcast-testsk_ only
Renders with sample data — no quota use, no history entry.
| Name | In | Type | |
|---|---|---|---|
id | path | string |
200 | Sent to the caller. |
get/v1/broadcast-quotask_ only
200 |
|
get/v1/events/{id}/broadcastssk_ only
| Name | In | Type | |
|---|---|---|---|
id | path | string |
200 | Broadcasts with counts. |
get/v1/broadcasts/{id}/recipientssk_ only
| Name | In | Type | |
|---|---|---|---|
id | path | string |
200 | Recipients with sent/failed status. |
Email templates
Per-company confirmation/reminder templates with shortcodes: [name] [email] [ticket_url] [event_title] [event_date] [event_time] [event_location] [event_message] [company_name].
get/v1/email-templatessk_ only
Optional ?locale= for per-language templates; localized built-in defaults exist for en / zh-Hant / zh-Hans / ja.
| Name | In | Type | |
|---|---|---|---|
locale | query | string |
200 | Templates. |
put/v1/email-templates/{type}sk_ only
type is confirmation or reminder. Unknown shortcodes are rejected (400 unknown_placeholders).
| Name | In | Type | |
|---|---|---|---|
type | path | confirmation | reminder | |
locale | query | string |
200 | Saved. |
delete/v1/email-templates/{type}sk_ only
| Name | In | Type | |
|---|---|---|---|
type | path | confirmation | reminder |
200 | Reverted. |
post/v1/email-templates/{type}/testsk_ only
| Name | In | Type | |
|---|---|---|---|
type | path | confirmation | reminder |
200 | Sent to the caller. |
post/v1/events/{id}/email-testsk_ only
Body: { type, message?, locale? } — renders the event's confirmation/reminder with sample attendee data and mails only the caller.
| Name | In | Type | |
|---|---|---|---|
id | path | string |
200 | Sent to the caller. |
Webhooks
HMAC-SHA256-signed deliveries with retries. See docs/WEBHOOKS.md for verification code.
get/v1/webhookssk_ only
200 | Endpoints (plan-limited: free 1 / pro 5). |
post/v1/webhookssk_ only
http(s) URLs only; hostnames resolving to private ranges are rejected (SSRF guard). The whsec_… signing secret is returned once.
{
url: string // required
events: string[] // required
}
201 | Created. {
webhook:
{
id: string
url: string
events: string[] // Subscribed types, e.g. event.published, registration.created.
enabled: boolean // Auto-disabled after 10 consecutive failures (owner emailed).
secret: string // whsec_… signing secret — returned once at creation.
createdAt: string
}
} |
patch/v1/webhooks/{id}sk_ only
| Name | In | Type | |
|---|---|---|---|
id | path | string |
200 | Updated. |
delete/v1/webhooks/{id}sk_ only
| Name | In | Type | |
|---|---|---|---|
id | path | string |
200 | Deleted. |
post/v1/webhooks/{id}/testsk_ only
| Name | In | Type | |
|---|---|---|---|
id | path | string |
200 | Delivery attempt result. |
post/v1/webhooks/{id}/push-allsk_ only
Initial sync / recovery: queues the complete current state to the endpoint.
| Name | In | Type | |
|---|---|---|---|
id | path | string |
200 | Queued. |
get/v1/webhooks/{id}/deliveriessk_ only
| Name | In | Type | |
|---|---|---|---|
id | path | string |
200 | Recent deliveries with status/attempts. |
post/v1/webhooks/deliveries/{id}/redeliversk_ only
| Name | In | Type | |
|---|---|---|---|
id | path | string |
200 | Requeued. |
Reports
Registration/view analytics.
get/v1/reports/overviewsk_ only
Per-day registrations/views series (timezone-correct local buckets) and per-event confirmed/checked-in/attendance/fill/view counts.
| Name | In | Type | |
|---|---|---|---|
days | query | 14 | 30 | 90 |
200 | Report payload. |
GDPR
Right-to-erasure execution.
post/v1/gdpr/erase-attendeesk_ only
Anonymizes every registration and broadcast-recipient record for the email across your account: identity, answers, and ticket QR are gone; counts and statistics stay truthful; the email may register again. Irreversible.
{
email: string // required
}
200 |
|
404 | No records for that email. |
Platform
Health and utility endpoints.
get/v1/healthno auth
200 | OK |