app.updated

📘

Supported Regions and Base URLs

Theapp.updated event is emitted when a Talkdesk administrator updates settings for the partner app on AppConnect.

Payload Types

AttributeDescription
users
string
Users that are assigned licenses to the partner app
subscription
string
App subscription that the customer selected
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
account_name
string
The customer's Talkdesk account name
app_version_id
string
Unique identifier of the partner app's version
app_version_name
string
The name of the partner app's version

📘

The users and subscription objects will contain properties based on the user action (e.g. if the number of licenses didn't change, no key named 'licenses' will be in the event).

Payload Example

{
  "id": "be4cfd0a01a046ec98fde433d973d259",
  "created_at": "2016-06-14T17:23:07Z",
  "api_version": "1",
  "type": "app.updated",
  "app_id": "f918e2623486417791f3b5a18ca746ce",
  "app_version_id": "970d6643b6604a9d8ec77d470a3903cf",
  "app_version_name": "app_version_name",
  "data": {
    "installation_id": "9514148a170c4d4aaa344a540cec08c5",
    "account_id": "052c3763ee0745c68a1f65f25b0bf273",
    "account_name": "starship",
    "users": {
      "adding": ["5729d479081762d39b00009e"],
      "removing": []
    },
    "subscription": {
      "adding": {
        "name": "Paid Plus",
        "licenses": "10"
      }
    }
  },
  "_links": {
    "root": {
      "href": "https://api.talkdeskapp.com"
    },
    "self": {
      "href": "https://api.talkdeskapp.com/apps/f918e2623486417791f3b5a18ca746ce/events/be4cfd0a01a046ec98fde433d973d259"
    }
  }
}

The links section contains:

AttributeDescription
selfURL to retrieve the event content
rootURL to Talkdesk's API Gateway

🚧

Troubleshooting

If 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.