Events

You can use the API to get or set event information.

The Event Model

Key	Type	Description
id	String	The unique identifier for the event which is given by Tiledesk.
name	String	The event name. You can find the standard Smartify events here
project_user	Object	The user who creates the event.
attributes	Object	The custom attributes which are set for the event.
createdAt	String	The time (ISO-8601 date string) when the event was created.
updatedAt	String	The time (ISO-8601 date string) when the event was updated.
createdBy	String	The unique identifier of the row creator
id_project	String	The unique identifier of the project

---

Get all events

GET https://panel.smartifyai.in/api/:project_id/events

Path Parameters

Name	Type	Description
project_id	string	The Project Id is a unique code assigned to your project when you create it in Tiledesk.

Query Parameters

Name	Type	Description
sortField	string	What field to sort the results by.
direction	string	Sort direction: 1 or -1. Return the results in ascending or descending order. defaults to desc
page	number	What page of results to fetch. Defaults to first page.

Headers

Name	Type	Description
Authorization	string	Authorization token. Basic Auth or JWT

Success (200) Example

{
   ...
}

---

Get an event by id

GET https://panel.smartifyai.in/api/:project_id/events/:id

Path Parameters

Name	Type	Description
id	string	The event identifier
project_id	string	The project_id is a unique code assigned to your project when you create it in Smartify

Headers

Name	Type	Description
Authorization	string	Authorization token. Basic Auth or JWT
Content-Type	string	Use "application/json" value

Success (200) Example

{
   ..
}

---

Fire a new custom event and save it

POST https://panel.smartifyai.in/api/:project_id/events

With this endpoint you can fire a custom event. Your event name should be:

event.emit.EVENT_NAME

to correctly identify your custom event. You can find the standard Smartify events here

Path Parameters

Name	Type	Description
project_id	string	The project_id is a unique code assigned to your project when you create it in Smartify

Headers

Name	Type	Description
Authorization	string	Authorization token. Basic Auth or JWT
Content-Type	string	Use "application/json" value

Request Body

Name	Type	Description
name	string	The event name
attributes	object	The event custom attributes

Success (200) Example

{
   ..
}

---

Previous: Tags · Next: Jwt

Last updated 2 years ago