About the API-modul
An API (application programming interface) allows different systems to communicate with each other. This means that information can be transferred between RAYVN and other systems automatically, without having to enter the same information manually in both places.
With RAYVN's API module, you can connect RAYVN to other systems your organization already uses. For example, you can use it to keep users, contacts, and other information automatically up to date.
Why use the API module?
Here are some examples of how the API can be used:
- Keep users and contacts up to date from another system, such as an HR system, Entra ID or a personnel registry. This means you don't have to register and update the same people manually in several systems.
- Retrieve data from logs and incidents, including entries, participants, and status for use in your own reporting or analytics tools.
- Keep contact lists up to date from an external system, so the contact information in RAYVN stays up to date.
The main benefit is that it can save time and reduce the amount of manual work. It can also help ensure that the information in RAYVN is kept up to date.
The API module is a separate add-on and is not included in the standard RAYVN setup. There is an additional cost for the module. Please contact us if you would like to activate it for your account.
How to get started
Once the API module has been activated for your account, you can create an API token and set up the integration using the instructions in "How to activate API for your account".
This is a good place to start when setting up an integration. For more information on the actual endpoints and data models, contact us to receive the Customer Instructions.
Frequently asked questions
What does the API module cost?
The API module has an additional cost on top of the standard RAYVN package. Please contact us for pricing.
What access does an API token have?
All API calls require an API token that is tied to a user in your account. Currently, an API token applies at the group level.
Is there a test or sandbox environment?
No, there is currently no separate test or sandbox environment. API calls are made against the actual data in your account.
If you want to test an integration without affecting your normal users or logs, we recommend creating a separate test group in your account structure, and creating a dedicated API token from within that group. The token will then only have access to the test group and any subgroups beneath it, not the rest of the account.
Can RAYVN automatically notify our system when something happens (webhooks)?
No. The API currently works by having your system retrieve the information from RAYVN. There is currently no mechanism for RAYVN to send automatic notifications to your system.
Is the API the same as SCIM or automatic user provisioning?
No. SCIM is a separate integration used for automatic user provisioning, for example through Entra ID, but the SCIM integration is included in the API module. Read more in the article "About the SCIM integration".
Does the API cover all functionality in RAYVN?
No. The API currently covers core functionality such as users, responders, contacts and contact lists, groups and teams, sites and resources, scenarios and templates, files, logs, and messages.
If you are looking for a specific function and are unsure whether it is available through the API, please contact us or see the Costumer Instruction document.