Skip to main content
POST
Create Event
This endpoint creates a new event in your account. Use it to set up events where you’ll need identity verification and secure access control. What it does:
  • Creates a new event with the details you provide
  • Generates a unique ID for the event that you’ll use in other API calls
  • Sets up the foundation for sending invites and registering attendees
When to use it:
  • When organizing a new conference, meeting, or secure access location
  • When you need to create a new venue for identity verification
  • At the beginning of your event planning process

Request Body

The request body should include the event details following the EventCreate schema:

Response

The API returns the created event object with all its details, including the generated event ID:
Important fields:
  • type: Use “dated” for one-time events with start/end times, or “fixed” for permanent locations
  • imageUrl: An image representing your event (shows up in notifications and the check-in interface)
  • instructions: Special guidance for attendees that will appear in their invitations

Authorizations

x-api-key
string
header
required

API key authentication. Add your API key as the value of the 'x-api-key' header.

Body

application/json
title
string
required
imageUrl
string
required
location
EventLocation · object
required
description
string
default:""
instructions
string
default:""
start_timestamp
integer | null
end_timestamp
integer | null
type
enum<string>
default:dated
Available options:
fixed,
dated
is_deleted
boolean
default:false

Response

Successful Response

title
string
required
imageUrl
string
required
location
EventLocation · object
required
id
string
required
description
string
default:""
instructions
string
default:""
start_timestamp
integer | null
end_timestamp
integer | null
type
enum<string>
default:dated
Available options:
fixed,
dated
is_deleted
boolean
default:false
created_at
string<date-time> | null