Subscriptions

Create a new subscription

POST https://panel.smartifyai.in/api/: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

curl -v -X POST -H 'Content-Type:application/json' -u [email protected]:123456 \
-d '{"event":"request.create", "target":"https://webhook.site/c312005b-5042-49e9-a769-0f3ba4245b51"}' \
https://panel.smartifyai.in/api/5b55e806c93dde00143163dd/subscriptions

Retrieve all subscriptions

GET https://panel.smartifyai.in/api/: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)

[
  {
    "__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"
  },
  ...
]

Get a subscription by id

GET https://panel.smartifyai.in/api/: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)

{
  "__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"
}

Delete a subscription by id

DELETE https://panel.smartifyai.in/api/: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)

{
  "_id": "5c81593adf767b0017d1aa66",
  "updatedAt": "2019-03-07T17:47:38.393Z",
  "createdAt": "2019-03-07T17:47:38.393Z",
  "lead_id": "SRbb2PfbSFcgICv9VQBcURZeloh1",
  "fullname": "Guest",
  "attributes": { ... },
  "id_project": "5b55e806c93dde00143163dd",
  "createdBy": "system",
  "__v": 0
}

Update a subscription

PUT https://panel.smartifyai.in/api/: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)

{
  "__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"
}

Example

curl -v -X PUT -H 'Content-Type:application/json' -u [email protected]:123456 \
-d '{"event":"request.create", "target":"https://webhook.site/c312005b-5042-49e9-a769-0f3ba4245b51"}' \
https://panel.smartifyai.in/api/5b55e806c93dde00143163dd/subscriptions/5c879fb4f1ae6600173b8c75

Get the subscriptions logs

GET https://panel.smartifyai.in/api/:project_id/subscriptions/history

The endpoint receives subscription call logs.

Experimental

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

Response (200)

[
  {
    "_id": "5e3ae8309ae7ee0017d91609",
    "event": "message.create",
    "target": "https://tiledesk.requestcatcher.com/test",
    "response": "{\"statusCode\":200,\"body\":\"request caught\",\"headers\":{\"date\":\"Wed, 05 Feb 2020 16:07:11 GMT\",\"content-length\":\"14\",\"content-type\":\"text/plain; charset=utf-8\",\"connection\":\"close\"},\"request\":{\"uri\":{\"protocol\":\"https:\",\"slashes\":true,\"auth\":null,\"host\":\"tiledesk.requestcatcher.com\",\"port\":443,\"hostname\":\"tiledesk.requestcatcher.com\",\"hash\":null,\"search\":null,\"query\":null,\"pathname\":\"/test\",\"path\":\"/test\",\"href\":\"https://tiledesk.requestcatcher.com/test\"},\"method\":\"POST\",\"headers\":{\"Content-Type\":\"application/json\",\"x-hook-secret\":\"0060287d-9486-4f00-a4db-a254f998dbd1\",\"accept\":\"application/json\",\"content-length\":6005}}}",
    "body": "\"request caught\"",
    "err": null,
    "id_project": "5e37f45c4d82de00178b96ad",
    "createdAt": "2020-02-05T16:07:12.089Z",
    "updatedAt": "2020-02-05T16:07:12.089Z",
    "__v": 0
  },
  .....
]

Example

curl -v -X GET -u [email protected]:123 \
https://panel.smartifyai.in/api/5e37f45c4d82de00178b96ad/subscriptions/history

PreviousImport multiple messages into Smartify using REST APIs from third party app NextJwt

Last updated 1 month ago

hashtagCreate a new subscription

hashtagPath parameters

hashtagHeaders

hashtagRequest body

hashtagResponse (200)

hashtagExample

hashtagRetrieve all subscriptions

hashtagPath parameters

hashtagHeaders

hashtagResponse (200)

hashtagGet a subscription by id

hashtagPath parameters

hashtagHeaders

hashtagResponse (200)

hashtagDelete a subscription by id

hashtagPath parameters

hashtagHeaders

hashtagResponse (200)

hashtagUpdate a subscription

hashtagPath parameters

hashtagHeaders

hashtagRequest body

hashtagResponse (200)

hashtagExample

hashtagGet the subscriptions logs

hashtagPath parameters

hashtagQuery parameters

hashtagHeaders

hashtagResponse (200)

hashtagExample

Create a new subscription

Path parameters

Headers

Request body

Response (200)

Example

Retrieve all subscriptions

Path parameters

Headers

Response (200)

Get a subscription by id

Path parameters

Headers

Response (200)

Delete a subscription by id

Path parameters

Headers

Response (200)

Update a subscription

Path parameters

Headers

Request body

Response (200)

Example

Get the subscriptions logs

Path parameters

Query parameters

Headers

Response (200)

Example