This executes an http request based on the data configured in the routine. The data between {{ }} is replaced with the data coming from the related event.
ex: {{trackableId}} will be replaced with the event trackable id. The field executionOrder
configures the order of the routines executions in case a managed event has more than one routine assigned.
{
"name": "http_post_web_hook",
"rootVenueScopeId": "42",
"description": "This routine executes an http request.",
"routineType": "HTTP_WEB_HOOK_ROUTINE",
"body": "trackableId={{trackableId}},geofenceId={{geofenceId}},eventType={{eventType}}, assetName={{name}}, externalId={{externalId}}, custom_prop_name={{custom_prop_name}} event_custom_data={{event_custom_data}}",
"requestUrl": "http://localhost:1080/test_path?query_string_param={{trackableId}}",
"httpMethod": "POST",
"httpHeaders": {
"custom_http_header": "custom_http_header_value"
},
"executionOrder": 1,
"conditionalExpression":"assignedAssetDto!=null",
"remoteExecutorAgentId": "125487"
}
Field | Description | Possible values |
---|---|---|
name | The name of the routine. | Any text (has to be unique) For example:
|
description | The description of the routine. | Any text. For example:
|
rootVenueScopeId | Delivered by Favendo. This is the ID of the venue. | A specific integer |
routineType | The type of the routine. | HTTP_WEB_HOOK_ROUTINE |
body | Only needed when the routineType “HTTP_WEB_HOOK_ROUTINE” is selected. | Body of the webhook (optional) |
requestUrl | Only needed when the routineType “HTTP_WEB_HOOK_ROUTINE” is selected. | URL of the webhook |
httpMethod | Only needed when the routineType “HTTP_WEB_HOOK_ROUTINE” is selected. |
|
httpHeaders | Only needed when the routineType “HTTP_WEB_HOOK_ROUTINE” is selected. | Header of the webhook (optional) |
Title | Only needed when the routineType “NOTIFICATION” is selected. | N.A. |
Text | Only needed when the routineType “NOTIFICATION” is selected. | N.A. |
Priority | Only needed when the routineType “NOTIFICATION” is selected. | N.A. |
targetList | Only needed when the routineType “NOTIFICATION” is selected. | N.A. |
durationInSeconds | Only needed when the routineType “NOTIFICATION” is selected. | N.A. |
executionOrder | Describes the order of the routines executions in case a managed event has more than one routine assigned. | Integer |
conditionalExpression | Condition that needs to be met in order for the routine to be executed. It is expressed in SpEL, and it always needs to return a boolean value. The expression can also reference properties from the triggered event. If the field is empty, the routine is always executed (defaults to true). For SpEL docs see https://docs.spring.io/spring-framework/docs/4.1.x/spring-framework-reference/html/expressions.html | Spring expression language. See 04. Spring expression language for more information. |