Developer Overview

Promptside Developer Icon Promptside Developer Icon


Promptside has been designed as a powerful ticketing platform for developers. Here are some examples of things we want you to be able to build using Promptside APIs.

  • A mobile app that sells tickets using a native experience
  • A web integration that displays event details and pricing on an external site
  • A custom check-in process for your attendees
  • Integration with a third-party accounting or POS system
  • A custom event management system which uses Promptside behind the scenes for ticketing functions
  • An online/streaming event which requires paid access

API rollout

Many Promptside APIs are being used internally, and it's our goal to open up virtually all of them to the public over the coming months. The reason for this gradual rollout is simply to ensure that all public APIs are stable, consistent and well-documented, giving you a reliable foundation to build on.

We will also be releasing SDKs for popular languages and frameworks, starting with iOS and Android (coming in 2020).

REST APIs Preview

Promptside has multiple REST APIs, optimised for different use cases and audiences.

Core API

The Core API provides full access to the Promptside data model, including tenant management, event management and sales operations. Use this API to automate functions you would normally perform through the Promptside dashboard. It should be called from server-side applications, or from an authorised user's device (eg. an event manager).

Self-Service API

The Self-Service API is specifically optimised for user-facing ticket sales applications. It's safe to call it from an attendee's device, because:

  • it does not expose any internal details about the event (eg. commissions)
  • it does not allow any privileged operations (eg. sale limit overrides)

Access control

Promptside REST APIs use OAuth 2.0 authentication. All API calls require an access token to be included as an HTTP header.

Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

  • Access tokens have a short lifetime (usually 1 hour) but you can programmatically request a fresh one at any time.
  • To request an access token, you need a Client ID. A Client ID is a permanent credential that identifies your specific application or integration.
  • The ability to request client IDs will be available soon (Q2 2020).

Each OAuth access token has a defined scope. The scope determines which APIs the token will provide access to.

It's possible to request a single multi-scope access token that provides access to several APIs. The available scope names are documented in the Reference guides for each API.

Early access

Let us know if you would like to be one of the first developers to build an integrated solution with Promptside.