Configuring a Zendesk plugin - Amazon Q Business

Configuring a Zendesk plugin

Zendesk is a customer relationship management system that helps businesses automate and enhance customer support interactions by creating tickets to track work. If you’re a Zendesk user, you can create an Amazon Q Business plugin to allow your end users to create Zendesk cases from within their web experience chat.

To create a Zendesk plugin, you need configuration information from your Zendesk instance to set up a connection between Amazon Q and Zendesk and allow Amazon Q to perform actions in Zendesk.

For more information on how to use plugins during your web experience chat, see Using plugins.


Before you configure your Amazon Q Zendesk plugin, you must do the following:

  • As an admin, set up a new user in your Zendesk instance with scoped permissions for performing actions in Amazon Q.

  • (Optional) Create an API token for that new user.

  • Note your Zendesk username and Zendesk password/API token. You will need this basic authentication information for creating an AWS Secrets Manager secret during the plugin configuration process.

  • Note the base URL of your Zendesk instance. For example:

Service access roles

To successfully connect Amazon Q to Zendesk, you need to give Amazon Q the following permission to access your Secrets Manager secret to get your Zendesk credentials. Amazon Q assumes this role to access your Zendesk credentials.

The following is the service access IAM role required:

{ "Version": "2012-10-17", "Statement": [{ "Effect": "Allow", "Action": [ "secretsmanager:GetSecretValue" ], "Resource": [ "arn:aws:secretsmanager:{{your-region}}:{{your-account-id}}:secret:[[secret-id]]" ] } ] }

If you use the console and choose to create a new IAM role, Amazon Q creates the role for you. If you use the console and choose to use an existing secret, or you use the API, make sure your IAM role contains these permissions.

Creating a plugin

To create a Zendesk plugin for your web experience chat, you can use AWS Management Console or the CreatePlugin API operation. The following tabs provide a procedure for creating a Zendesk plugin using the console and code examples for the AWS CLI.


To create a Zendesk plugin

  1. Sign in to the AWS Management Console and open the Amazon Q console at

  2. From the Amazon Q console, in Applications, select the name of your application from the list of applications.

  3. From the left navigation menu, choose Enhancements, and then choose Plugins.

  4. For Plugins, choose Add plugin.

  5. For Add plugins, choose Zendesk.

  6. For Zendesk, enter the following information:

    1. Name, Plugin name – A name for your Amazon Q plugin. The name can include hyphens (-), but not spaces, and can have a maximum of 1,000 alphanumeric characters.

    2. For Service access – Choose Create and add a new service role or Use an existing service role. Make sure that your service role has the necessary permissions.

    3. URL – The base URL of your Zendesk instance. For example:

    4. Authentication – Choose Create and add a new secret or Use an existing one. Your secret must contain the following information:

      1. Secret name – A name for your Secrets Manager secret.

      2. Zendesk username – The username for your Zendesk user.

      3. Zendesk password/API token – The password/API token for your Zendesk user.

  7. Tags – optional – An optional tag to track your plugin.

  8. Choose Save.


To create a Zendesk plugin

aws qbusiness create-plugin \ --application-id application-id \ --display-name display-name \ --type ZENDESK \ --server-url // \ --auth-configuration basicAuthConfiguration="{secretArn=<secret-arn>,roleArn=<role-arn>}"