While api_keys grant you access to our rest API in order to process requests in your account and our backend, different scopes associated with your api_keys will determine and limit what those keys have access to and what permissions are granted to them. An api_key with read only scopes will never be able to create or delete accounts for you.
Why Do Scopes Matter?
Security: If a hacker manages to steal an API key, they are restricted by its scopes. If a compromised key only has a "read-only" scope, the hacker can look at data, but they cannot delete or alter your account.
Transparency: All your api_keys (the names given to them, not the keys themselves) are visible in your Kaisa Dashboard and also the different scopes associated with them. You can revoke any key at any time from our platform.
Scopes available
Different functionalities in Kaisa can be triggered with different scopes, and you need to ensure the api_key you create contains the relevant scope for its purpose. You can see in our Documentation what scopes are needed for each service or conversation.
For example, to query all accounts in your Organisation in Kaisa using our v3 base url:
You will need to add in the Headers an api_key with the ACCOUNTS_READ scope.
| Scope | Description |
| Api_key_read | Manage third-party integrations, API and OAuth related settings |
| Accounts_read | A common scope required for most resources. |
| Conversations_form_read | To use with our Conversations resource, to get a list of Forms or as one of the requirements to Delete them. |
| Conversations_form_write | To be used to create Forms in our Conversations resource, and to Delete them. |
| Conversations_whatsapp_read | To be used with our Whatsapp solution, required to get a list of Whatsapp conversations, and one of the scopes required to Delete them. |
| Conversations_whatsapp_write | To be used with our Whatsapp solution, required to create Whatsapp conversations, and one of the scopes required to Delete them. |
| Workflows_read | Required to get a list of Workflows from your Engagement Builder |
| Workflows_write | Required to create or edit any workflows and deploy those changes. |
| Workflows_transactions_read | To be used with our Survey Workflow, this scope is required to get a list of Survey answers. |
| Workflows_custom_trigger | Required to send inbound webhooks towards Kaisa, as explained here. You can read about this set up in this article. |
Where can I find my api_keys?
You can create an api_key as described here and they keys (the alias, not the actual key) are located in your Settings page in the Kaisa dashboard.
Remember: When an api_key is created, it is displayed once, and will not be stored visibly in our frontend. You can always revoke an api_key and generate a new one if needed.
The Kaisa Dashboard.
Comments
0 comments
Please sign in to leave a comment.