MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with Eventicka API.

Authenticating requests

To authenticate requests, include a parameter api_key in the body of the request.

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your api key by visiting your Eventicka account dashboard, then navigate to Manage Events -> Integration -> Api Keys.

Endpoints

POST api/events/list

Example request:
curl --request POST \
    "https://eventicka.com/api/events/list" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://eventicka.com/api/events/list"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/events/list

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/getOrderSync/{eventId}

Example request:
curl --request POST \
    "https://eventicka.com/api/getOrderSync/ipsum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://eventicka.com/api/getOrderSync/ipsum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/getOrderSync/{eventId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventId   string   

Example: ipsum

POST api/sync/{eventId?}

Example request:
curl --request POST \
    "https://eventicka.com/api/sync/sed" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://eventicka.com/api/sync/sed"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/sync/{eventId?}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventId   string  optional  

Example: sed

POST api/getSyncInvitations/{eventId}

Example request:
curl --request POST \
    "https://eventicka.com/api/getSyncInvitations/consectetur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://eventicka.com/api/getSyncInvitations/consectetur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/getSyncInvitations/{eventId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventId   string   

Example: consectetur

POST api/eventSync

Example request:
curl --request POST \
    "https://eventicka.com/api/eventSync" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://eventicka.com/api/eventSync"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/eventSync

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/getDatabase

Example request:
curl --request POST \
    "https://eventicka.com/api/getDatabase" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://eventicka.com/api/getDatabase"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/getDatabase

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/forgotPassword/{emailId?}

Example request:
curl --request GET \
    --get "https://eventicka.com/api/forgotPassword/fugit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://eventicka.com/api/forgotPassword/fugit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
 

{
    "success": false,
    "data": "We couldn't find this email address in our records."
}
 

Request   

GET api/forgotPassword/{emailId?}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

emailId   string  optional  

Example: fugit

GET api/checkVersion

Example request:
curl --request GET \
    --get "https://eventicka.com/api/checkVersion" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://eventicka.com/api/checkVersion"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
 

{
    "version": "1.0.5"
}
 

Request   

GET api/checkVersion

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/sns/webhook

Example request:
curl --request GET \
    --get "https://eventicka.com/api/sns/webhook" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://eventicka.com/api/sns/webhook"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET api/sns/webhook

POST api/sns/webhook

PUT api/sns/webhook

PATCH api/sns/webhook

DELETE api/sns/webhook

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/zap/connect

Example request:
curl --request POST \
    "https://eventicka.com/api/zap/connect" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://eventicka.com/api/zap/connect"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/zap/connect

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/zap/subscribe

Example request:
curl --request POST \
    "https://eventicka.com/api/zap/subscribe" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"api_key\": \"corporis\"
}"
const url = new URL(
    "https://eventicka.com/api/zap/subscribe"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "api_key": "corporis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/zap/subscribe

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

api_key   string   

Example: corporis

DELETE api/zap/unsubscribe

Example request:
curl --request DELETE \
    "https://eventicka.com/api/zap/unsubscribe" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://eventicka.com/api/zap/unsubscribe"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/zap/unsubscribe

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/zap/recent-orders

Example request:
curl --request GET \
    --get "https://eventicka.com/api/zap/recent-orders" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"api_key\": \"et\",
    \"event_id\": 6
}"
const url = new URL(
    "https://eventicka.com/api/zap/recent-orders"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "api_key": "et",
    "event_id": 6
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

GET api/zap/recent-orders

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

api_key   string   

Example: et

event_id   integer   

Example: 6

GET api/zap/recent-events

Example request:
curl --request GET \
    --get "https://eventicka.com/api/zap/recent-events" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"api_key\": \"ducimus\"
}"
const url = new URL(
    "https://eventicka.com/api/zap/recent-events"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "api_key": "ducimus"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

GET api/zap/recent-events

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

api_key   string   

Example: ducimus

GET api/zap/recent-attendee

Example request:
curl --request GET \
    --get "https://eventicka.com/api/zap/recent-attendee" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"api_key\": \"quisquam\",
    \"event_id\": 13
}"
const url = new URL(
    "https://eventicka.com/api/zap/recent-attendee"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "api_key": "quisquam",
    "event_id": 13
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

GET api/zap/recent-attendee

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

api_key   string   

Example: quisquam

event_id   integer   

Example: 13

GET api/zap/recent-check-in

Example request:
curl --request GET \
    --get "https://eventicka.com/api/zap/recent-check-in" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://eventicka.com/api/zap/recent-check-in"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET api/zap/recent-check-in

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/zap/recent-events

Example request:
curl --request POST \
    "https://eventicka.com/api/zap/recent-events" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"api_key\": \"suscipit\"
}"
const url = new URL(
    "https://eventicka.com/api/zap/recent-events"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "api_key": "suscipit"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/zap/recent-events

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

api_key   string   

Example: suscipit

POST api/zap/find-event

Example request:
curl --request POST \
    "https://eventicka.com/api/zap/find-event" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://eventicka.com/api/zap/find-event"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/zap/find-event

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/zap/call-hook

Example request:
curl --request GET \
    --get "https://eventicka.com/api/zap/call-hook" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://eventicka.com/api/zap/call-hook"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request   

GET api/zap/call-hook

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json