Skip to content

Add docs for SimpliSafe system notifications #12115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 18, 2020
Merged

Add docs for SimpliSafe system notifications #12115

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
df39423
Add docs for SimpliSafe system notifications
bachya Feb 18, 2020
c9c3940
Updates per PR code review
bachya Feb 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions source/_integrations/simplisafe.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,11 @@ For any property denoting a volume, the following values should be used:

## Events

Automations can listen for `SIMPLISAFE_EVENT` events. Anytime one of these events is
received, it will come with event data that contains the following keys:
### `SIMPLISAFE_EVENT`

`SIMPLISAFE_EVENT` events represent events that appear on the timeline of the SimpliSafe
web and mobile apps. When received, they come with event data that contains the
following keys:

* `changed_by`: the PIN that triggered the event (if appropriate)
* `event_type`: the type of event
Expand Down Expand Up @@ -130,3 +133,14 @@ following values:
* `doorbell_detected`
* `entry_detected`
* `motion_detected`

### `SIMPLISAFE_NOTIFICATION`

`SIMPLISAFE_NOTIFICATION` events represent system notifications that would appear in the
messages section of the SimpliSafe web and mobile apps. When received, they come with
event data that contains the following keys:

* `category`: The notification category (e.g., `error`)
* `code`: The SimpliSafe code for the notification
* `message`: The actual text of the notification
* `timestamp`: The UTC timestamp of the notification