Sweescape

Get aggregated SweeAnalytics for an event. Always returns three sections: sales (conversion funnel), attendance (visitor stats and breakdown), and entryControls (check-in summary).

get_analytics

List the columns of an audience that can be used as personalization variables in an email/SMS campaign. Each column can be referenced in the content as a merge tag, e.g. {{ firstName }}. One of these columns is also what set_campaign_content needs as audience_recipient_column (the column holding the recipient email for email, or phone for SMS).

get_audience_variables

Get the content of an automation: type, recipient column and filter, and for an email type the sender, subject and emailContent, the exact block document update_automation expects back as email_content. emailContent is null when the email was designed with the previous builder.

get_automation_content

Get the content of a campaign: sender, subject, recipient column and, for email, emailContent: the exact block document set_campaign_content expects back as email_content. An edit is get_campaign_content → change what you need → set_campaign_content with the whole email. emailContent is null when the campaign has no content yet or was designed with the previous builder.

get_campaign_content

Get the custom domain serving the ticketing page of an event: the host, its status (pending until the DNS record is in place and the certificate issued, then active), the last verification error, the exact CNAME record to create at the DNS provider, and the pages served per language.

get_custom_domain

Get the builder catalog used to compose an email (campaign or automation) as editable blocks: the email-level root props (inbox preview text, backgrounds, width, font, colors), the shape of the email JSON, the accepted value shape of each field type, how to write {{ variables }}, and every block with its props, allowed values and an example. Compose emails with these blocks, never as one Html block, so a human can edit them afterwards in Sweescape. Optional category filter (layout, typography, media, advanced) narrows the blocks only.

get_email_components

Get the full details of one event of the authenticated organization: name, type, dates, venue, status, participant count and tax rate (a decimal, 0.1 means 10%).

get_event

Get the builder catalog used to compose a white label ticketing page: the page-level root props (SEO and indexing, the palette and fonts every block can reference with "theme:<colorName>", the ticket modal styling), the shape of the page JSON, the accepted value shape of each field type (spacing, gap, radius and length take either a single value or a per-device map { desktop, tablet, mobile }, which is how a page is made responsive), and every component with its props, allowed values and an example. Optional category filter (layout, typography, media, advanced) narrows the components only.

get_ticketing_components

Get the white label ticketing page of an event: whether it is published, and its builder content. Mode "full" (the default) returns the exact document that update_ticketing expects back, so an edit is get_ticketing → change what you need → update_ticketing with the whole thing. Mode "outline" is a read-only map of a large page (block tree with type, id, label and hideOn, plus the root props): it is a summary, NOT a document you can send back to update_ticketing, and it does not carry the per-device spacing values.

get_ticketing

Get the ticket types of an event, including the ones hidden behind a ticket code: name, priceTtc (the tax-inclusive price the buyer pays), quota, sold count, remaining stock, minQuantity and maxQuantity per order, and visibility ("public", or "code" when the ticket only appears once a buyer enters a ticket code that unlocks it). These field names mirror the create_ticket inputs.

get_tickets

List the audiences/segments of the organization (read-only, used to target campaigns): id, name, type and size.

list_audiences

List the automations of an event: id, name, status and scheduled timing.

list_automations

List the extensions installed on an event and whether each one is enabled. An installed and enabled extension can add participant columns, contribute builder blocks and sandboxed UI to the ticketing page, and run its declarative rules during checkout. Installing or removing an extension on an event is a human action in Sweescape.

list_event_extensions

List the events of the authenticated Sweescape organization. Optional filters: status (upcoming/past, computed from the dates), search by name, date_from/date_to on the start date, and pagination.

list_events

List the extensions of the authenticated user library: id, package_name, status (draft/published), version, declared scopes and which kinds of contribution the manifest carries. Manifests are not included here because they are large; pass extension_id to get one extension in full, with its manifest and the UI files already uploaded and their hosted urls. Use the id with set_extension_manifest and upload_extension_files.

list_extensions

List the extensions published on the Sweescape marketplace, with their package_name, version, author and the capability scopes each one declares. These are the extensions an organizer can add to their library and then install on an event from the Sweescape interface.

list_marketplace_extensions

List the verified sending domains of the organization. The "from" email of an email campaign (set_campaign_content) must use one of these domains, otherwise sending will be refused. Returns an empty list if no domain is verified yet.

list_senders

List ticket codes. WITHOUT event_id you get only the codes shared across several ticketings (the ones that live at organization level, with one common quota); a code created for a single event is NOT in that list. WITH event_id you get every code usable on that event, the shared ones and the ones created for it alone — so to see all the codes of an organization, call it once per event. A ticket code either lowers the price (discount) or unlocks tickets whose visibility is "code" (access), or both. Each entry reports its scope, the quota, its unit (per order or per ticket), the usage and what remains.

list_ticket_codes

Fill the content of a draft campaign created with create_campaign. For email: from_email (must use a verified domain from list_senders), from_name, subject, and email_content (the email as editable blocks built against get_email_components; personalise with {{ VARIABLE }} tags from get_audience_variables). Sweescape generates the HTML from the blocks, and a human can keep editing them in the email builder. For sms: message. audience_recipient_column must be a column from get_audience_variables that holds the recipient address. Never sends; sending stays a human action in Sweescape.

set_campaign_content

Set or replace the manifest of an extension created with create_extension. The manifest declares its scopes (capabilities) and its contributions: participant columns, sandboxed UI on a given surface, declarative blocks, and rules that react to checkout lifecycle events. manifest.id must equal the extension package_name; omit "author" (set server-side). The extension stays unpublished; publishing to the marketplace is admin-only in Sweescape.

set_extension_manifest

Set the type and content of an automation. Provide content as { recipient_column, recipient_filter: { base_filter, advanced_filters }, content: { type: "email"|"email-feedback", from?, subject, email_content } } or { type: "sms"|"sms-feedback", content }. email_content is the email as editable blocks built against get_email_components; its HTML is generated by Sweescape. Personalise an email with {{ column }} variables from the participant columns, plus {{ eventName }}, {{ ticketName }} and, for email-feedback, {{ feedbackFormUrl }} (link a Button to it). An SMS takes no variable: it is sent exactly as written, and a text containing {{ }} is refused. Stays in draft; can never activate or deactivate.

update_automation

Replace the scope of a ticket code that spans several ticketings: which events it works on (event_ids) and which tickets it unlocks (ticket_ids). Both lists replace the current ones, so send the full lists, not the additions. The code itself, its discount and its quota are unchanged. Only a code created with event_ids has an editable scope: a code created for a single event with event_id is bound to that event and this call is refused on it.

update_ticket_code_scope

Update the unpublished white label ticketing page of an event. Replaces the current draft content (the builder has no field-level patch), so read it with get_ticketing first and send the whole page back with your changes. Refused when the page is published: a live ticketing is only edited by a human in Sweescape. Always stays unpublished; never publishes.

update_ticketing

Upload one or more UI bundle files (the sandboxed iframe content) for an extension, and get back their hosted URLs. Generate the file content (e.g. an HTML page with inline JS/CSS for surface checkout.step), upload it here, then put the returned url into the matching uiExtension.entry of set_extension_manifest. The iframe talks to the host only through the postMessage bridge: it posts sweescape:ready, receives sweescape:init with its config and event context, and can send sweescape:set-field, sweescape:resize, sweescape:checkout, or a sweescape:request naming one of the bridge methods context.get, column.takenValues, participant.current, order.current and ticketCode.unlock. It cannot reach the network unless net:fetch and allowedDomains are declared. Allowed file types: html, js, css, svg, json, and common image types. Max 5 MB per file.

upload_extension_files

Ask Sweescape to re-check the DNS record of the custom domain of an event and issue its certificate. Call it after the CNAME has been created at the DNS provider. The domain becomes active once the check passes; while it fails, the result reports why. DNS propagation can take a few minutes, so a first failure is not final.

verify_custom_domain