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
}
'import requests
url = "https://api.securegate.ai/events"
payload = {
"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
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};
fetch('https://api.securegate.ai/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.securegate.ai/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.securegate.ai/events"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"location\": {\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"description\": \"\",\n \"instructions\": \"\",\n \"start_timestamp\": 123,\n \"end_timestamp\": 123,\n \"type\": \"dated\",\n \"is_deleted\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.securegate.ai/events")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"location\": {\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"description\": \"\",\n \"instructions\": \"\",\n \"start_timestamp\": 123,\n \"end_timestamp\": 123,\n \"type\": \"dated\",\n \"is_deleted\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.securegate.ai/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"location\": {\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"description\": \"\",\n \"instructions\": \"\",\n \"start_timestamp\": 123,\n \"end_timestamp\": 123,\n \"type\": \"dated\",\n \"is_deleted\": false\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Event Management
Create Event
Create a new event
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
}
'import requests
url = "https://api.securegate.ai/events"
payload = {
"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
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};
fetch('https://api.securegate.ai/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.securegate.ai/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.securegate.ai/events"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"location\": {\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"description\": \"\",\n \"instructions\": \"\",\n \"start_timestamp\": 123,\n \"end_timestamp\": 123,\n \"type\": \"dated\",\n \"is_deleted\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.securegate.ai/events")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"location\": {\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"description\": \"\",\n \"instructions\": \"\",\n \"start_timestamp\": 123,\n \"end_timestamp\": 123,\n \"type\": \"dated\",\n \"is_deleted\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.securegate.ai/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"location\": {\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"description\": \"\",\n \"instructions\": \"\",\n \"start_timestamp\": 123,\n \"end_timestamp\": 123,\n \"type\": \"dated\",\n \"is_deleted\": false\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}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:
Important fields:
- 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 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"
}
type: Use “dated” for one-time events with start/end times, or “fixed” for permanent locationsimageUrl: 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
API key authentication. Add your API key as the value of the 'x-api-key' header.
Body
application/json
Show child attributes
Show child attributes
Available options:
fixed, dated Response
Successful Response
Show child attributes
Show child attributes
Available options:
fixed, dated ⌘I
