app.installed

📘
Supported Regions and Base URLs

👍
Access and Registration
Authentication

Payload Types

Attribute	Description
client_id string	Client ID issued for the Talkdesk account, for the partner app API access
client_secret string	Client Secret issued for the Talkdesk account, for the partner app API access
public_key string	JWT public key issued for the Talkdesk account, for the partner app API access
private_key string	JWT private key issued for the Talkdesk account, for the partner app API access
key_id string	JWT key ID issued for the Talkdesk account, for the partner app API access
key_algorithm string	JWT key algorithm Possible values are `ES256`, `ES384`, `ES512`, `PS256`, `PS384` and `PS512`
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_id string	Unique identifier of the partner app
event_id string	Unique identifier for the event
app_version_id string	Unique identifier of the partner app's version
app_version_name string	The name of the partner app's version

Payload Example

{
  "id": "8b62e0c6001548d7b59f8240d79cb0d7",
  "created_at": "2016-06-14T16:23:07Z",
  "api_version": "1",
  "type": "app.installed",
  "app_id": "f918e2623486417791f3b5a18ca746ce",
  "app_version_id": "970d6643b6604a9d8ec77d470a3903cf",
  "app_version_name": "app_version_name",
  "data": {
    "installation_id": "9514148a170c4d4aaa344a540cec08c5",
    "account_id": "052c3763ee0745c68a1f65f25b0bf273",
    "account_name": "starship",
    "client_id": "23de1fee7658490f8021465553402546",
    "client_secret": "CLIENT_SECRET",
    "private_key": "PRIVATE_KEY",
    "public_key": "PUBLIC_KEY",
    "key_id": "78a574781e434d0b9991edd0994fbeed",
    "key_algorithm": "ES256"
  },
  "_links": {
    "root": {
      "href": "https://api.talkdeskapp.com"
    },
    "self": {
      "href": "https://api.talkdeskapp.com/apps/f918e2623486417791f3b5a18ca746ce/events/3214155a170c4d4aaa344a540ceckrik1"
    },
    "userinfo": {
      "href": "https://api.talkdeskapp.com/users/me"
    },
    "authorization": {
      "href": "https://starship.talkdeskid.com/oauth/authorize"
    },
    "tokens": {
      "href": "https://starship.talkdeskid.com/oauth/token"
    },
    "installation": {
      "href": "https://api.talkdeskapp.com/apps/f918e2623486417791f3b5a18ca746ce/installations/9514148a170c4d4aaa344a540cec08c5"
    },
    "widget_url": {
      "href": "https://prd-cdn-talkdesk.talkdesk.com/tdconnect-widget/latest/td.connect.js"
    }
  }
}

The links section contains:

Attribute	Description
userinfo	URL to retrieve the user info
self	URL to retrieve the event content
installation	URL to retrieve installation data
authorization	URL to be used during the authorization process
tokens	URL to be used to obtain an access token
widget	URL from JavaScript to be included in order to provide the Talkdesk header
root	URL to Talkdesk's API Gateway

🚧
Retry Policy
Since this event contains sensitive information, it will not be available in any other form. For that reason, if Talkdesk fails to deliver these events, the app will not be able to invoke the API on behalf of the account.

📘
Troubleshooting
If you have questions or technical issues, please open a ticket using this form.