Events
You can use the API to get or set event information.
The Event Model
id
String
The unique identifier for the event which is given by Tiledesk.
name
String
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://api.tiledesk.com/v3/:project_id/events
Path Parameters
project_id
string
the Project Id is a unique code assigned to your project when you create it in Tiledesk.
Query Parameters
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
Authorization
string
authorization token. Basic Auth or JWT
Get a event by id
GET
https://api.tiledesk.com/v3/:project_id/events/:id
Path Parameters
id
string
the event identifier
project_id
string
The project_id is a unique code assigned to your project when you create it in Tiledesk
Headers
Authorization
string
authorization token. Basic Auth or JWT
Content-Type
string
use "application/json" value
Fire a new custom event and save it
POST
https://api.tiledesk.com/v3/:project_id/events
With this endpoint you can fire a custom event. You event name should be
event.emit.EVENT_NAME
to correctly identify your custom event. You can find the standard Tiledesk events here
Path Parameters
project_id
string
The project_id is a unique code assigned to your project when you create it in Tiledesk
Headers
Authorization
string
authorization token. Basic Auth or JWT
Content-Type
string
use "application/json" value
Request Body
name
string
the event name
attributes
object
The event custom attributes
Last updated