DOCSEARCHbyAlgolia
Submit Docs

Spektrix Developer Documentation

website·Indexed 29 days ago

https://qawebcompsa7316a0577d9a.z6.web.core.windows.net/docs/Introduction

Technical documentation for integrating Spektrix, featuring the API v3, web components for memberships, gift vouchers, and login status, and the Payments API for custom checkout flows. Includes guidance on authentication, signing requests, and managing event instances, customers, and baskets.

Tokens
84.7K
Snippets
362
Records
642
Agent score
45%

What's inside Spektrix

  1. Overview of Spektrix Direct Checkout

    Direct Checkout is a streamlined flow allowing customers to complete purchases without logging in. Customers are identified by their email address; the system either associates the order with an existing record or automatically creates a new one. This flow is intended for sessions without a logged-in customer. If a customer is already logged in, the Customer Checkout flow should be used instead.

  2. Overview of Abandoned Cart tracking workflow

    Abandoned Cart tracking allows Dotdigital to track users who start but do not complete a purchase to trigger personalized reminder emails. The process works by using the spektrix-basket-summary web component to push identity and basket data into the data layer. A Dotdigital tag, loaded via Google Tag Manager (GTM), reads these events and sends them to Dotdigital. The mapping from Spektrix basket data to the Dotdigital schema is handled automatically by the component.

  3. Overview of Spektrix iframe integration tools

    Spektrix provides iframe integration tools where much of the content is automatically generated by the Spektrix system. A dedicated iframe content tool is available to help developers identify which elements within the iframe flow are editable and which are system-generated defaults that cannot be changed.

  4. Overview of Spektrix Subsites

    A Spektrix Subsite is a pre-built purchase pathway provided by Spektrix that exists independently of a client's main marketing website. It can be used as a temporary or permanent solution and is often used in conjunction with integrated tools (such as iframes, APIs, or web components). Common use cases include linking to a subsite for ticket purchases while using integrated web components for donations and memberships on the main site, or creating a dedicated microsite for a specific event like a festival.

  5. Overview of Custom Payment Types for Partner Products

    Custom Payment Types allow organizations to record payments made via methods not processed directly within Spektrix (such as cheques, invoices, or BACS). Third-party integrations (e.g., EPOS, video streaming platforms) should use these endpoints to create a record of the transaction type and value. All Custom Payment API calls must be made in System Owner mode and require authentication; requests made in web/public mode will return a 401 Unauthorized error.

  6. Overview of Spektrix Zapier Integration

    Spektrix integrates with Zapier to allow clients to connect their systems with over 6,000 software platforms. The integration utilizes the System Owner mode of the Spektrix API, enabling the automation of repetitive import tasks and data centralization through configurable workflows called 'Zaps'.

  7. Overview of Spektrix Integration Tools

    Spektrix provides four primary tools for integrating its ticketing, marketing, and fundraising functionality into a client's website. These tools are designed to be used in tandem, allowing developers to mix and match based on the required level of customization and available resources.

  8. Overview of Spektrix Express Checkout

    The Express Checkout is a mobile-optimized alternative to the classic checkout flow in Spektrix. It presents a simplified, single-page-like experience for customers, although it technically consists of multiple pages to maintain Iframe URLs for analytics. It is recommended for new integrations as it reduces friction by allowing customers to complete orders without requiring a password and dynamically hiding irrelevant sections (e.g., skipping delivery methods if only one is available).

  10. Overview of the Spektrix Agency API

    The Agency API allows Spektrix clients to grant Agents live access to sell event tickets. Key operational details include:

    • Agent Setup: Clients create a Customer record for the Agent. Agents may have multiple records for different commission agreements, seat access, or discounting.
    • Requirements: Each Agent record requires a unique email address and a mobile phone number for 2-factor authentication (2FA).
    • Capabilities: Agents can create, manage, and confirm multiple concurrent baskets for end-to-end purchase.
    • Payments: The API does not handle payment processing; transactions are recorded against the 'Agency API' payment method and logged to the Agent's account.
    • Data Access: Access is restricted to sales-related data; the API does not provide access to the broader customer database.
    • End Customer Info: Agents can write back the end customer's name, first line of address, and reference number as additional transaction information.

  11. Overview of Spektrix API v1.0 (Legacy)

    The Spektrix API v1.0 is a legacy API used by 3rd party web applications to retrieve high-level event feeds, including basic event information and instance dates/times. It is primarily intended for creating event calendars and lists. It is no longer supported for new integrations; new projects should use API v3. To transition a user from an event list to a purchase, it is recommended to pass the customer into the Iframe booking path, specifically at the chooseseats.aspx Iframe.

  12. Understand Spektrix Queue behavior and constraints

    Spektrix provides a built-in queueing system to manage high-demand ticket onsales. Key operational rules include:

    • Single Queue: There is only one queue per client. All events with queueing enabled share this single queue. Events without queueing enabled are unaffected.
    • Single Entry: Customers queue once. Upon reaching the front, they can purchase tickets for all queue-enabled events/instances without re-queuing. However, confirming a transaction and returning to the purchase path will place them at the back of the queue.
    • Basket Requirements: Customers must have an empty basket before entering the queue. If they have items in their basket, they will be prompted to either checkout/confirm those items or empty the basket.