Api

API

The API transport allows to reach any service provider using POST, PUT or GET URLs (Like SMS provider, etc). It can be used in multiple ways:

• The same text built from the Alert template is available in the variable

$msg, which can then be sent as an option to the API. Be carefull that HTTP GET requests are usually limited in length.

• The API-Option fields can be directly built from the variables defined in Template-Syntax but without the 'alert->' prefix. For instance, $alert->uptime is available as $uptime in the API transport

• The API-Headers allows you to add the headers that the api endpoint requires.

• The API-body allow sending data in the format required by the API endpoint.

• Send as form. This option allows you to send the body content as form data url encoded. Enable this if your endpoint is expecting fields to be sent as key=value pairs. Please ensure newlines aren't present in any of your variables as can be the case with $msg.

A few variables commonly used :

Example:

The example below will use the API named sms-api of my.example.com and send the title of the alert to the provided number using the provided service key. Refer to your service documentation to configure it properly.

The example below will use the API named wall-display of my.example.com and send the title and text of the alert to a screen in the Network Operation Center.

The example below will use the API named component of my.example.com with id 1, body as json status value and headers send token authentication and content type required.