Skip to main content
POST
/
events
Create Event
curl --request POST \
  --url https://api.securegate.ai/events \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "title": "<string>",
  "imageUrl": "<string>",
  "location": {
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>",
    "country": "<string>"
  },
  "description": "",
  "instructions": "",
  "start_timestamp": 123,
  "end_timestamp": 123,
  "type": "dated",
  "is_deleted": false
}
'
{
  "title": "<string>",
  "imageUrl": "<string>",
  "location": {
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>",
    "country": "<string>"
  },
  "id": "<string>",
  "description": "",
  "instructions": "",
  "start_timestamp": 123,
  "end_timestamp": 123,
  "type": "dated",
  "is_deleted": false,
  "created_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.securegate.ai/llms.txt

Use this file to discover all available pages before exploring further.

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: 
{
  "title": "Annual Tech Conference",
  "description": "Join us for the annual tech conference featuring speakers from top tech companies",
  "instructions": "Please arrive 30 minutes before the event starts for registration",
  "imageUrl": "https://example.com/event-image.jpg",
  "location": {
    "address": "123 Conference Center Dr",
    "city": "San Francisco",
    "state": "CA",
    "zipCode": "94105",
    "country": "USA"
  },
  "start_timestamp": 1677609600,
  "end_timestamp": 1677696000,
  "type": "dated"
}

​
Response

The API returns the created event object with all its details, including the generated event ID: 
{
  "id": "event-123",
  "title": "Annual Tech Conference",
  "description": "Join us for the annual tech conference featuring speakers from top tech companies",
  "instructions": "Please arrive 30 minutes before the event starts for registration",
  "imageUrl": "https://example.com/event-image.jpg",
  "location": {
    "address": "123 Conference Center Dr",
    "city": "San Francisco",
    "state": "CA",
    "zipCode": "94105",
    "country": "USA"
  },
  "start_timestamp": 1677609600,
  "end_timestamp": 1677696000,
  "type": "dated",
  "is_deleted": false,
  "created_at": "2023-02-28T12:00:00Z"
}
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