ChakraHQ APIs
HomeSign In
HomeSign In
  1. Home
  • API Keys
  • Response Format
  • Whatsapp
    • Inbound Events Webhook
    • Send Whatsapp Template Message For Process
      POST
    • Send Whatsapp Template Message For A Phone Number
      POST
    • Upload Public Media
      POST
    • Whatsapp Messages API (pass-through)
      POST
  • Platform
    • Process
      • Fetch Process By Id
      • List Processes
      • Create Process
      • Update Process
      • Update Process By Primary Key
      • Delete Process
      • Delete Process By Primary Key Value
      • Bulk Create Process API
      • Bulk Update Process API
    • Task
      • Create Task API
    • User
      • List Users API
      • List Users API (V2)
      • Fetch User API
      • Fetch User API (V2)
      • Update User API
    • Photo
      • Fetch Photo API
      • Upload Photo API
      • Upload Photo API With Id
    • Background Job
      • Fetch Background Job
      • Fetch Background Job Entries API
    • Fetch Config
      GET
  1. Home

API Keys

To be able to use Chakra APIs, first you need to create an API Key for your usecase from the API Keys section.

Create An API Key#

To create an API Key you need to provide the following information:
Name - Name of the key. Please use a meaningful name. This makes management of keys easier.
Description (optional) - Description for the api keys
Access Role - Chose a role for the new API Key. the API Key will inherit and be limited by the privileges supplied by the assigned role. Ensure that publicly exposed apiKeys have the least privileged role needed to accomplish the task.

Using the API Key#

In the details view of an api key find the Access Tokens section. Copy the access token to use in your api calls.
The access token needs to be passed as a Bearer token as part of the Authorization header while making api calls.
Sample curl request below
Curl request with sample access token

API Key Guidelines#

Always use separate api keys for separate usecases
Only provide as much privilege (by the role that is assigned during creation) as is needed by your usecases
Be careful when using API Keys in frontend side code. These keys should have the least privilege possible
Modified at 2024-11-11 11:18:06
Next
Response Format
Built with