HttpPostRecipient
Description
The HttpPostRecipient is used to push an alarm to an external API.
Implementation
- Copy and paste the component into the AlarmService
- Link the "alarm" slot of alarm classes to the "routeAlarm" slot of the HttpPostRecipient
Properties
- Status: Indicates the general status of the component, {ok} if the operation was successful or {fault} to indicate abnormal behavior
- FaultCause: Indicates the cause of a configuration error. The FaultCause is empty if the component is properly configured.
- OptionalAlarmData: It allows you to add extra information about the alarm. It should be a tag listed in the "metadata" slot of the alarm extension. Different tags can be displayed and should be separated by a semicolon ";"
- TimeFormat: Used to encode dates before sending it to the API. This is a standard Java format.
- Authentication: The type of authentication needed. Available types can be found in btibCore palette, Auth folder.
- Url: The address of the API server to make the POST request
- PingUrl: The address to ping to test the API server
- Headers: Optional HTTP headers
Actions
- Ping: Ping the "pingUrl" address to try to test the API server