The app.trial_ended event is emitted when a trial of the partner app has been expired by the system, or ended by the user in the event of app uninstallations or subscription changes.
Supported Regions and Base URLs
Access and RegistrationAuthentication
Payload Types
| Attribute | Description |
|---|---|
| installation_id string | Unique identifier of the partner app's installation in the Talkdesk account of the user |
| account_id string | Unique identifier for the customer's Talkdesk account |
| ended_at datetime | The date time when the trial ended |
| expires_at datetime | Expiration date and time for the trial subscription - in this case, it will be the same as the event date |
| ended_reason string | The reason for the trial ending: trial_expired, app_uninstalled or plan_upgraded. Trials will end because the system had expired the trial (trial_expired), or if a customer uninstalls the app (app_uninstalled) or upgrades the subscription to a paid one (plan_upgraded). |
| ended_by string | The initiator of the trial ending: system or user. Trials will end because the system had expired the trial (system), or if a customer uninstalls the app or upgrades subscription (user). |
| app_version_id string | Unique identifier of the partner app's version |
Payload Example
{
"id": "a16521d26f89418dab1402e68c5a4ba7",
"created_at": "2017-08-18T10:29:52.000+00:00",
"api_version": "1",
"type": "app.trial_ended",
"app_id": "8fcf7a3762d94f938e71b3a42618fd14",
"app_version_id": "dd357179dc4a4f8a9c243638eb122f69",
"data": {
"installation_id": "4400ebd85fa04322abf5b64de93dc913",
"account_id": "573491d5df012e3242001b52",
"expires_at": "2017-08-18T10:29:52.000+00:00",
"ended_at": "2017-08-08T10:29:52.000+00:00",
"ended_reason": "trial_expired",
"ended_by": "system"
},
"_links": {
"root": {
"href": "https://api.talkdeskapp.com"
},
"self": {
"href": "https://api.talkdeskapp.com/apps/8fcf7a3762d94f938e71b3a42618fd14/events/a16521d26f89418dab1402e68c5a4ba7"
},
"installation": {
"href": "https://api.talkdeskapp.com/apps/8fcf7a3762d94f938e71b3a42618fd14/installations/4400ebd85fa04322abf5b64de93dc913"
}
}
}The links section contains:
| Attribute | Description |
|---|---|
| self | URL to retrieve the event content |
| installation | URL to retrieve installation data |
| root | URL to Talkdesk's API Gateway |
TroubleshootingIf you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.