Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

eventId

string

options

BulkUpdateTicketsOptions

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { tickets } from '@wix/events';

const wixClient = createClient({
  modules: { tickets },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function bulkUpdateTickets(eventId, options) {
  const response = await wixClient.tickets.bulkUpdateTickets(eventId, options);
}

bulkUpdateTickets() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { tickets } from '@wix/events';

const wixClient = createClient({
  modules: { tickets },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function bulkUpdateTickets(eventId, options) {
  const response = await wixClient.tickets.bulkUpdateTickets(eventId, options);
}

bulkUpdateTickets() with Dashboard app access

bulkUpdateTickets

BulkUpdateTicketsResponse

CheckInTicketsOptions

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { tickets } from '@wix/events';

const wixClient = createClient({
  modules: { tickets },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function checkInTickets(eventId, options) {
  const response = await wixClient.tickets.checkInTickets(eventId, options);
}

checkInTickets() with Dashboard app access

checkInTickets

CheckInTicketResponse

DeleteTicketCheckInsOptions

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { tickets } from '@wix/events';

const wixClient = createClient({
  modules: { tickets },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function deleteTicketCheckIns(eventId, options) {
  const response = await wixClient.tickets.deleteTicketCheckIns(eventId, options);
}

deleteTicketCheckIns() with Dashboard app access

deleteTicketCheckIns

DeleteTicketCheckInResponse

identifiers

GetTicketIdentifiers

GetTicketOptions

Retrieves a ticket by the unique ticket number.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { tickets } from '@wix/events';

const wixClient = createClient({
  modules: { tickets },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function getTicket(identifiers, options) {
  const response = await wixClient.tickets.getTicket(identifiers, options);
}

getTicket() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { tickets } from '@wix/events';

const wixClient = createClient({
  modules: { tickets },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function getTicket(identifiers, options) {
  const response = await wixClient.tickets.getTicket(identifiers, options);
}

getTicket() with Dashboard app access

getTicket

TicketingTicket

Options for defining the returned list of tickets.

ListTicketsOptions

Retrieves a list of up to 100 tickets.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { tickets } from '@wix/events';

const wixClient = createClient({
  modules: { tickets },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function listTickets(eventId, options) {
  const response = await wixClient.tickets.listTickets(eventId, options);
}

listTickets() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { tickets } from '@wix/events';

const wixClient = createClient({
  modules: { tickets },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function listTickets(eventId, options) {
  const response = await wixClient.tickets.listTickets(eventId, options);
}

listTickets() with Dashboard app access

listTickets

ListTicketsResponse

UpdateTicketIdentifiers

UpdateTicketOptions

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { tickets } from '@wix/events';

const wixClient = createClient({
  modules: { tickets },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function updateTicket(identifiers, options) {
  const response = await wixClient.tickets.updateTicket(identifiers, options);
}

updateTicket() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { tickets } from '@wix/events';

const wixClient = createClient({
  modules: { tickets },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function updateTicket(identifiers, options) {
  const response = await wixClient.tickets.updateTicket(identifiers, options);
}

updateTicket() with Dashboard app access

updateTicket

UpdateTicketResponse

# Introduction

The Tickets API allows you to manage tickets for your site's events.

With the Tickets API you can:

- Archive tickets.
- Check in tickets, and delete ticket check-ins.
- Get the information about purchased tickets.



To use the Tickets API, install the `@wix/events` package using npm or Yarn:
  ```console
npm install @wix/events
```

or

```console
yarn add @wix/events
```

Then import `{ tickets }` from `@wix/events`:

```js
import { tickets } from '@wix/events'
```
  

events_tickets

BaseEventMetadata

eventType

The identification type and identity data.

identity

IdentificationData

instanceId

archived

boolean

A unique ticket number which is assigned automatically when creating a ticket.

ticketNumber

tickets

ChannelType

CheckIn

created

Ticket numbers which check-ins to delete.

FacetCounts

counts

FormResponse

inputValues

Predefined sets of fields to return.
- `TICKET_DETAILS`: Returns `ticketNumber`, `orderNumber`, `ticketDefinitionId`, `name`, `price`, `free`, `policy`, `qrCode`, `checkIn`, `orderStatus`, `orderArchived`, `archived`, `orderFullName`, `ticketPdf`, `checkInUrl` and `ticketPdfUrl`.
- `GUEST_DETAILS`: Returns `guestDetails`.
- `GUEST_FORM`: Returns `guestDetails.form`.

Default: If a fieldset is not included in the request, returns only the `memberId` and `anonymized` fields.

fieldset

GuestDetails

contactId

email

firstName

form

Whether ticket belongs to assigned guest.

guestAssigned

lastName

GuestDetailsUpdate

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

appId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

identityType

WebhookIdentityType

InputValue

inputName

value

values

facet

Number of items to load per page. See [Pagination](/wix-events-v2/pagination).

limit

number

Offset. See [Pagination](/wix-events-v2/pagination).

offset

orderNumber

orderStatus

Textual search filter - search is performed on `"orderFullName"`, `"guestFullName"`, and `"ticketNumber"`.

searchPhrase

Sort order.

Default: `"ticketNumber"`:`"asc"`.

sort

Ticket states. Possible values:
- `ORDER_ARCHIVED`: Returns tickets of the archived orders.
- `ORDER_ACTIVE`: Returns tickets of the non-archived orders.
- `TICKET_ARCHIVED`: Returns archived tickets.
- `TICKET_ACTIVE`: Returns non-archived tickets.
- `CHECKED_IN`: Returns checked-in tickets.
- `NON_CHECKED_IN`: Returns tickets that are not checked in.
- `FREE`: Returns free tickets.
- `PAID`: Return paid tickets.
- `MEMBER`: Return members' tickets.

state

ticketDefinitionId

facets

Total tickets matching the given filters.

total

Money

amount

Currency in the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. For example, `USD`.

currency

Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.

OnTicketOrderUpdatedHandler

event

TicketOrderUpdatedEnvelope

void

OnlineConferencingLogin

link

password

OrderStatus

OrderUpdated

Whether order was archived and excluded from results.

checkoutForm

Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account.

confirmed

language

locale

Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc.

method

status

Order updated timestamp in ISO UTC format.

timestamp

Whether event was triggered by GDPR delete request.

triggeredByAnonymizeRequest

updated

State

Ticket

Anonymized tickets no longer contain personally identifiable information (PII).

anonymized

checkIn

Ticket form response (only assigned tickets contain separate forms).

onlineConferencingLogin

price

ticketName

TicketFieldset

data

metadata

Whether ticket was anonymized by GDPR delete.
Anonymized tickets no longer contain personally identifiable information (PII).

Whether the ticket is visible in an order.

onTicketOrderUpdated( )

Permission Scopes