Developer Settings

Developer settings provide access to configuration specifically for accessing additional services including API.

API Credential Management

The Company Key and Secret Value is being deprecated as of September 30, 2022.

A new Credential Management interface is available at Settings > Developer Settings > API.

Use your subdomain (without the https://) as the username. For example, if the URL you visit is https://foobar.domain.co then the subdomain value for your username is foobar. This was previously the Company Key.

Create as many API credentials as you need for internal use.

Be aware that some third-party integrations require the creation of API credentials.

As a result, depending on the integrations you have, you may already see API credentials configured for Advanced Reporting, or others.

If you lose or forget your token, you can regenerate the token. Be sure to store this in a secure location. 

The API Credential Management Settings allow you to:

  • add new API credentials

  • disable / enable credentials

  • regenerate the secret token

  • or edit the name of an existing credential

Add an API credential

  1. Go to Settings > Developer Settings > API Credential management.

  2. Click the + Add API Credential button. An Add API Credential message will open.

  3. Enter a Name for the credentials.

  4. Click Create.

Edit the name of an API credential

  1. Go to Settings > Developer Settings > API Credential management.

  2. Click the Edit icon Edit the name to update the name.

Generate a new token

  1. Click the Refresh icon Refresh token to generate a new token.

    A warning message appears.

Warning: Regenerating a new token will immediately invalidate the previous token.

Anything using the previous token will generate authentication errors. Are you sure?

  • Cancel: there is no new token generated.

  • Regenerate: a new token is regenerated. Copy the new token and store in a secure place.