API Keys

ChiDesk provides a REST based API to allow other third-party applications to pull or push data into your ChiDesk account.

To control this access you must create and supply a generated API Key to your developer which they will be able to use to access your data.

Setup an API Key

  1. Browse to Settings - API Keys.
  2. Click New.
  3. Enter a Description for this API Key.
  4. A pre-generated key has been generated, this is what you must provide to your developer.
  5. If necessary you can specify what IP address range has access to use this key. This is an additional security measure to ensure access can only take place from a specific server.
  6. Click Save to save your new API Key.

Access the ChiDesk API

To access the ChiDesk API, your developer will post requests to specific URLs on your ChiDesk account. To authenticate themselves they must include a header key named ChiDeskApiKey containing the key generated above.

Have more questions? Submit a request


Please sign in to leave a comment.