Notification Rules

List notification rules

Returns a list of all notification rules for the authenticated user.
Notification rules define webhooks or other actions that are triggered when specific events occur.
This endpoint does not support pagination.

GET /api/3/notification_rules

Authentication

This endpoint requires authentication:

OAuth 2.0 Recommended

Use an OAuth 2.0 access token in the Authorization header. This is the recommended authentication method for all integrations. OAuth provides automatic token expiration, granular permission scopes, detailed usage tracking, and per-integration revocation. Learn how to obtain an access token.

Header Format:

Authorization: Bearer YOUR_ACCESS_TOKEN

Required Scopes:

account.notification_rule.readonly

Responses

200

List of notification rules retrieved successfully

Response Fields

id integer required

Unique identifier for the notification rule

eg. 100
name string required

Name of the notification rule

eg. Webhook for door access events
active boolean required

Whether this notification rule is currently active

eg. true
conditions array<object> required

Conditions that must be met for the rule to trigger

events array<object> required

Events that trigger this rule (at least one required)

actions array<object> required

Actions to perform when the rule triggers (at least one required)

401

Unauthorized - Invalid or missing authentication

Response Fields

error string
eg. unauthorized
error_description string
eg. The access token is invalid
403

Forbidden - User does not have permission

Response Fields

error string
eg. forbidden
error_description string
eg. You are not authorized to access this resource
500

Internal Server Error

Response Fields

error string
eg. internal_server_error
error_description string
eg. An unexpected error occurred

Request

curl -X GET \
  "https://api.doorflow.com/api/3/notification_rules" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Responses

List of notification rules retrieved successfully

[
  {
    "id": 100,
    "name": "Webhook for door access events",
    "active": true,
    "conditions": [
      {
        "type": null,
        "type_description": null,
        "value": null
      }
    ],
    "events": [
      {
        "code": null,
        "name": null
      }
    ],
    "actions": [
      {
        "type": null,
        "type_description": null,
        "data": null
      }
    ]
  }
]