...
Go to https://control.openpath.com/login and log in. To access the European Control CenterAlta Access, please go to https://control.eu.openpath.com/login.
Go to Configurations > Rules, then click the plus(+) sign in the top right corner to Create a Rule.
Enter a name and description for the rule, select a Trigger Type, then select an Entry.
In this example we want the rule to trigger on Entry Unlock events.
On the right side of the page, check Use JSON Editor.
...
“entry.unlocked” is the event type that will trigger the rule:
| Code Block | ||
|---|---|---|
| ||
{
"name": "Send Openpath event to Slack",
"description": "Notify Slack when front foor unlocks",
"version": "1.0",
"trigger": {
"properties": {
"event": {
"enum": [
"entry.unlocked"
]
},
"required": [
"event"
], |
Replace “####” with entry IDs to only trigger the rule when specific entries unlock.
| Code Block | ||
|---|---|---|
| ||
"data": {
"requiredallOf": [
{
"entryIdsproperties": {
], "_type": "properties": {entry",
"entryIds": {
"contains": {
"enum": [
####
]
}
}
}
}
]
}
}
}, |
Replace the URL below with your app’s Webhook URL.
| Code Block | ||
|---|---|---|
| ||
"variablesrequests": [ { "nametype": "base_urlhttp", "valueblocking": "https://hooks.slack.com/services/XXXXXXXXXXXXXXXXXXXXXXXXXX"false, } "preRequestDelaySeconds": ]0, "curlOptshttpParams": { "followLocationheaders": false,[ "maxRedirs": 10, "autoReferer": trueUser-Agent: Openpath/Rules Engine", "ssl_verifyPeer": 0, "connectTimeout"Content-Type: 10,application/json" "timeout": 10, ], "httpHeader": [ "method": "Content-type:application/json"post", ] }, |
...
"url": "https://hooks.slack.com/services/XXXXXXXXXXXXXXXXXXXXXXXXXX",
|
“body” is the data that will be sent to the specified Slack channel. If you’d like to format this differently, refer to Slack’s documentation. For an example of what this notification looks like, see below.
Note: To include a link to your organization’s Entry Activity Report, replace the ### in /o/###/reports in the example below with your OrgId.
| Code Block | ||
|---|---|---|
| ||
"requestsbody": [ { "curlOpts": { "post": 1, "postFields": "{\"username\":\"openpath\",\"icon_emoji\":\":openpath:\",\"channel\":\"webhooktest\",\"text\":\"{{event.event}} {{event.timestamp}} {{event.data.org.name}} {{event.data.entries.0.name}} Unlocked using {{event.data.requestType}} {{event.data.connectionType}} by {{event.data.userId}} at {{event.data.requestTimestamp}}\",\"attachments\":[{\"color\":\"warning\",\"title\":\"Click here to see Entry Report\",\"title_link\":\"https://control.openpath.com/o/###/reports/entryActivity\"}]}", "url": "{{base_url}}" } } ] } |
| Iframe | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...