Apps API

Overview

The Apps API retrieves detailed information about a specific installation of an app in a Talkdesk instance of a customer.

📘

Use Case

Talkdesk partners can take advantage of Apps API to get information about their app and any of its installations. The Apps API can be used to check the subscription plan and users in a given installation. Responses to webhook events, emitted by Events API, are also sent via Apps API.

👍

Access and Registration

Authentication

Usage

The Apps API allows getting information about all users that have been provisioned with accounts and can be utilized for creating and mapping corresponding user accounts in your system.

• Get information about an app.

• Get information about installation.

• Get the users enabled for a given installation.

• Set the state of the installation.

• Get the current subscription of the installation.

• Activate channels for the installation.

• Create a transition to 'acknowledged' of the installation's credentials resource.

• Rotate the installation's credentials.

• Get the list of apps.

• List channels for the installation.

• Get the installation trial information.

• Get a specific event from target app ID.

📘

Supported Regions and Base URLs

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.