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

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
Get all events

https://api.tiledesk.com/v1/:project_id/events
Request
Response
Request
Path Parameters
project_id
required
string
the Project Id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Query Parameters
sortField
optional
string
what field to sort the results by.
direction
optional
string
sort direction: 1 or -1. Return the results in ascending or descending order. defaults to desc
page
optional
number
what page of results to fetch. defaults to first page.
Response
200: OK
{
...
}

get
Get a event by id

https://api.tiledesk.com/v1/:project_id/events/:id
Request
Response
Request
Path Parameters
id
required
string
the event identifier
project_id
required
string
The project_id is a unique code assigned to your project when you create it in Tiledesk
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Content-Type
required
string
use "application/json" value
Response
200: OK
{
..
}

post
Create a new event

https://api.tiledesk.com/v1/:project_id/events
Request
Response
Request
Path Parameters
project_id
required
string
The project_id is a unique code assigned to your project when you create it in Tiledesk
Headers
Authorization
required
string
authorization token. Basic Auth or JWT
Content-Type
required
string
use "application/json" value
Body Parameters
name
required
string
the event name
attributes
optional
object
The event custom attributes
Response
200: OK
{
..
}