Subscriptions
Create a new subscription
POST https://api.tiledesk.com/v3/:project_id/subscriptions
This endpoint allows adding a new subscription.
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
event (string) — the event method
target (string) — the target URL
Response (200)
{
"__v": 0,
"updatedAt": "2019-03-12T12:01:56.462Z",
"createdAt": "2019-03-12T12:01:56.462Z",
"target": "https://webhook.site/c312005b-5042-49e9-a769-0f3ba4245b51",
"event": "request.create",
"id_project": "5b55e806c93dde00143163dd",
"createdBy": "5ab11c6b83dc240014d46095",
"_id": "5c879fb4f1ae6600173b8c75",
"secret": "56c189c8-33ae-4930-bd98-410a12aa45ce"
}Example
Retrieve all subscriptions
GET https://api.tiledesk.com/v3/:project_id/subscriptions
This endpoint retrieves all active subscriptions.
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
Response (200)
Get a subscription by id
GET https://api.tiledesk.com/v3/:project_id/subscriptions/:id
This endpoint retrieves a subscription by ID.
Path parameters
id (string) — the subscription 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
Response (200)
Delete a subscription by id
DELETE https://api.tiledesk.com/v3/:project_id/subscriptions/:id
This endpoint deletes a subscription by ID.
Path parameters
id (string) — the subscription 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
Response (200)
Update a subscription
PUT https://api.tiledesk.com/v3/:project_id/subscriptions/:id
This endpoint updates a subscription.
Path parameters
project_id (string) — The project_id is a unique code assigned to your project when you create it in Tiledesk
id (string) — the subscription identifier
Headers
Authorization (string) — authorization token. Basic Auth or JWT
Content-Type (string) — use "application/json" value
Request body
event (string) — the event method
target (string) — the target URL
Response (200)
Example
Get the subscriptions logs
GET https://api.tiledesk.com/v3/:project_id/subscriptions/history
The endpoint receives subscription call logs.
Path parameters
project_id (string) — The Project Id is a unique code assigned to your project when you create it in Tiledesk.
Query parameters
page (number) — what page of results to fetch. Defaults to first page.
Headers
Authorization (string) — authorization token. Basic Auth or JWT