Who can use this feature?
System administrators only
Our API keys provide access to read, write, and update many types of data in Qwil Messenger, allowing you to integrate Qwil with third-party applications.
There are three types of API Keys in the application:
System API keys - allow you to automate the administration of your organisation.
Master User API Keys - provide access to chat and contact related functionality on behalf of any user.
User API Keys - provide access to chat and contact related functionality.
As an admin, you can enable staff users to create personal API keys. You can also list and manage any API keys created by users in your organisation.
Security considerations
API Keys are very powerful and you should treat them as you would a password. It is best practice to revoke them if they are not being used and allow the fewest permissions possible.
To allow staff users to create User API keys:
- From your desktop, click on the admin menu.
- Click on Settings
- Click on the API Keys tab.
- Select the checkbox "Allow staff users to create and manage User API keys" and click Save.
- Staff users will now be able to create User API Keys.
Revoke staff users access to User API Keys
You can revoke access to User API Keys at any time. When you remove the permission, any existing keys will be automatically disabled and can no longer be used. To revoke access:
- From your desktop, click on the admin menu.
- Click on Settings
- Click on the API Keys tab.
- Unselect the checkbox "Enable staff users to create and manage User API keys" and click Save.
- All existing User API Keys will be disabled and staff users will no longer be able to create new keys.
Manage existing User API Keys
As an admin user, you can edit and delete existing User API Keys.
To edit a user's API Keys:
- From your desktop, click on the admin menu.
- Click on Staff or Clients.
- Locate the user whose User API Keys you wish to edit.
- Click on the User API Keys tab.
- Locate the User API Key you wish to edit or delete.
- Click on the three-dot menu and select Edit.
- A modal will open. Make any necessary changes and click Submit. Your changes will be saved.
To delete a user's API Keys:
- From your desktop, click on the admin menu.
- Click on Staff or Clients.
- Locate the user whose User API Keys you wish to edit.
- Click on the User API Keys tab.
- Locate the User API Key you wish to edit or delete.
- Click on the three-dot menu and select Delete.
- A confirmation modal will open. Click Confirm.
- The key will be deleted and can no longer be used.