Creating API Keys

Create API keys to authenticate third-party applications with the CxEngage REST API.

To create API keys:

  1. Go to Configuration > API Key Management.
  2. Click Create, then enter the following information:
    • Name: A descriptive name for the API key
    • Description:A short description of the key. This is optional.
    • Role:The user role the key applies to. These will have the same level of access as is defined in the role's permissions.
  3. Click Submit.

    A window containing information about the new API key displays.

    CxEngage API credentials

  4. Copy the API key and API secret and store it in a secure location.

    You will not be able to view the API secret again after you close this window.

  5. Click OK to close the window.

Use the API key and secret to authenticate with the CxEngage REST API and generate a token. See Authentication in the REST API documentation for more information.

You might also be interested in: