Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

You can receive Openpath Avigilon Alta notifications in Slack by setting up Openpath Avigilon Alta webhooks and creating a custom Slack app. This configuration requires the use of the Openpath Avigilon Alta Rules Engine’s JSON editor.

...

  1. Create a custom app following Slack’s instructions.

  2. Enable Incoming Webhooks for the custom app.

  3. Create an Incoming Webhook and select which Slack channel to post to.

  4. Under app settings, look for Webhook URLs for Your Workspace, then copy the Webhook URL.

Create a rule using JSON in OpenpathAvigilon Alta:

  1. Go to https://control.openpath.com/login and log in. To access the European Partner CenterAlta Access, please go to https://control.eu.openpath.com/login.

  2. Go to Configurations > Rules, then click the plus(+) sign in the top right corner to Create a Rule.

  3. Enter a name and description for the rule, select a Trigger Type, then select an EventEntry.

    1. In this example we want the rule to trigger on Entry Unlock events.

  4. On the right side of the page, check Use JSON Editor.

...

Iframe
srchttps://info.openpath.com/hubfs/images/kustomer-articles/openpath-to-slack-rule.png

...

width700
frameborderhide
titleOpenpath to slack
alignmiddle
height492
longdescOpenpath to slack

Create a rule using JSON, using the Slack app’s Webhook URL. Your rule should look something like this:

“entry.unlocked” is the event type that will trigger the rule:

Code Block
languagejson
{
  "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
languagejson
      "data": {
        "requiredallOf": [
          {
            "entryIdsproperties": {
       ],        "_type": "properties": {entry",
              "entryIds": {
                "contains": {
                  "enum": [
                    ####
                  ]
                }
              }
            }
          }
        ]
      }
    }
  },

Replace the URL below with your app’s Webhook URL.

Code Block
languagejson
  "variablesrequests": [
    {
      "nametype": "base_urlhttp",
      "valueblocking": "https://hooks.slack.com/services/XXXXXXXXXXXXXXXXXXXXXXXXXX"false,
    }  "preRequestDelaySeconds": ]0,
      "curlOptshttpParams": {
        "followLocationheaders": false,[
    "maxRedirs": 10,     "autoReferer"User-Agent: trueOpenpath/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
languagejson
  "requests": [
    {
      "curlOpts": {
        "post": 1,
        "postFields":  "body":"{\"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}}"
      }
 
  }   ]
}
Markdown
![slack webhook example](
Iframe
allowfullscreentrue
srchttps://info.openpath.com/hubfs/images/kustomer-articles/slack-webhook.png

...

width700
frameborderhide
titleslack-webhook
alignmiddle
height223
longdescslack webhook

Openpath notification in Slack example

...