How to use the Developer docs, API reference and widgets

Everything you need to build your integration is under Reference › Docs in the developer portal.

Guides

The Docs page lists step-by-step guides, starting with getting started, then purchases, widgets, payment, webhooks and compatibility. Select a guide to read it.

API reference

1. On the Docs page, open API reference and select View all.
2. Use Search operations to find an operation.
3. Open it to see its Parameters, Request body and Responses.

To use the API in your own tools, select Download OpenAPI on the Docs page. It downloads the API contract in OpenAPI format, which tools like Postman can import.

Widgets

Widgets add ready-made Shows screens to your site. Open Widgets to see each one:

• Event card: an event's image, name, date and venue, linking to your event page.
• Event page: event details with tickets, add-ons and seat selection.
• Checkout: collects your customer's name, email and phone, then opens payment.
• Payment: the official Shows payment screen, embedded or as a full page.
• Confirmation: the booking confirmation and delivery details after payment.

Event widgets need a project that can read events. Checkout widgets need a project that can sell, with your page's address registered on the project. If a widget says the project has no origins, add your site under Registered addresses on the project's Settings tab.