Document toolboxDocument toolbox

Authorizing Alerts API requests

Authorization header

To authorize your requests, add a standAloneToken header to your API request that contains a valid token.

Creating the required token

You can generate this token in the Administration → Credentials → Authentication tokens area of Devo. Click Create token, fill out the form, and click Create. Pay special attention to the following fields:

  • Choose Alert API in the type section.

  • Choose the authorized user.

  • Select required Target tables you want to work with. You will be able to define alerts only for the tables selected here so make sure you choose those you actually need.

The generated token will appear in the same area, in the table below. Click its name and copy the token value from the details window that appears. Learn more about tokens in Devo in Authentication tokens.

Token permissions

Note that the actions you can perform when you authorize your API access using a token are the ones you can perform according to your Role permissions in Devo. You can see the role permissions you need for each request type in Working with the Alerts API.

The actions you may perform with the Alerts API are determined by the permissions of the user associated to the token:

  • You need the Alert configuration and Triggered alerts permissions with View level to perform GET requests.

  • You need the Alert configuration and Triggered alerts permissions with Manage level to perform POST, PUT and DELETE requests.

image-20240716-104346.png

Header example

The following is an Alerts API request in cURL language authorized with the corresponding header:

curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/alerts/v1/alertDefinitions"

Â