Getting a list of integration ids from messaging without connecting to AI agents

This guide describes how to obtain your Zendesk Messaging integration ids without connecting to AI agents. After you’ve identified your integrations, you can assign a default responder to each channel so that AI agents don't automatically take over when it’s connected.

Zendesk Messaging integration ids refer to unique identifiers associated with the different messaging channels or integrations configured within your Zendesk instance. These ids are used to specify and route conversations through particular messaging channels—such as web widgets, mobile apps, or social messaging platforms—that are connected through Zendesk Messaging.

To use this guide, you'll need the following resources:

• Admin access to a Zendesk account
• Postman for making API requests
• The Sunshine Conversations Postman collection imported into Postman

Getting the app ids

The app id identifies your Zendesk account in Sunshine Conversations. You'll include it in API requests, such as the List integrations endpoint.

To get the app id, following the instructions in Creating and sharing the IDs and API key in Zendesk help.

After you create the API key, securely save the App ID, Key ID, and Secret Key values. You'll use these values later.

Getting the integration id

1. In Postman, open the Sunshine Conversations collection.

2. Click Integrations > GET List Integrations.

3. Replace "{appId}" in the URL with the App ID you copied above.

4. Click the Authorization tab, and select Basic Auth from the dropdown menu.

5. Set Username to your Key ID and Password to your Secret Key.

6. Click Send.

The response lists all of your integration ids. Each integration id specifies its type, making it easy to differentiate between them.

{
  "integrations": [
    {
      "id": "60c8e47e9cdba100d37ceaf5",
      "status": "active",
      "type": "line",
      "displayName": "LINE-test",
      "defaultResponder": {
        "id": "6102e772079aa800d362ecac",
        "name": "zd-answerBot",
        "integrationId": "60b64a363c8f7baaa5e512d1",
        "integrationType": "zd:answerBot",
        "deliverStandbyEvents": false,
        "nextSwitchboardIntegrationId": "60b64a36b1771600d386d8b0",
        "inherited": true
      }
    }
  ]
}