Skip to main content

Access tokens

Access tokens authenticate your requests to the Team Voice REST API.

warning

The REST API is still in beta and is subject to change.

Generating access tokens for the REST API​

To use the Polls REST API for creating, updating, and deleting polls, you need to configure access tokens. These tokens allow you to automate these actions and integrate with automation tools or external systems.

Steps to generate an access token​

  1. Navigate to the access tokens configuration:

    • Go to Team Voice settings and select the Access Tokens tab.

    The Access Tokens configuration in Team Voice settings

  2. Create a new access token:

    • Select Create Access Token.
    • Provide a descriptive name for the token, indicating its purpose (for example, Poll Management Token for Automation).

  3. Define the scope:

    • Set the scope of the token to limit its access to only the necessary content and actions. Avoid creating tokens that allow unrestricted access to all content.
    • For example, you might restrict the token to allow only operations related to polls within specific Jira or Confluence spaces.

  4. Generate and save the token:

    • After defining the scope, generate the token.
    • Copy and securely store the token. You will need it to authenticate your API requests.

Using the access token​

When making API requests, include the access token as a query parameter to authenticate your actions. The token ensures that your API calls are authorized to perform the specified operations.

Example:

https://<your-app-id>.hello.atlassian-dev.net/x1/<your-endpoint>?token=<your-access-token>
PlaceholderReplace with
<your-app-id>The app ID in the REST endpoint URL, copied from the Team Voice settings page
<your-endpoint>The endpoint path in the REST endpoint URL, copied from the Team Voice settings page
<your-access-token>The access token you generated

Best practices​

  • Scope Limitation: Always limit the scope of your access tokens to the minimum required for your integrations.
  • Token Security: Keep your access tokens secure. Do not share them or expose them in public repositories or unsecured locations.
  • Regular Review: Periodically review and revoke tokens that are no longer needed or are suspected to be compromised.

By following these guidelines, you can securely automate and manage polls using the REST API.