Update notification rule
Updates an existing notification rule. This replaces all conditions, events, and actions
with the new values provided in the request.
/api/3/notification_rules/{id}
Authentication
This endpoint requires authentication:
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
Parameters
Path Parameters
id
integer
Notification rule ID
Request Body
name
string
Name of the notification rule (required)
active
boolean
Whether this notification rule is active
call_back_url
string
Webhook callback URL to trigger when events occur (required)
match_event_codes
array
Array of event codes that trigger this rule (at least one required)
match_controller_ids
array
Array of door controller IDs to filter events (optional - if omitted, matches all controllers)
Example
{
"name": "Webhook for door access events",
"active": true,
"call_back_url": "https://example.com/webhook",
"match_event_codes": [
0
],
"match_controller_ids": [
0
]
}Responses
Notification rule updated 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)
Unauthorized - Invalid or missing authentication
Response Fields
error
string
eg. unauthorized
error_description
string
eg. The access token is invalid
Forbidden - User does not have permission
Response Fields
error
string
eg. forbidden
error_description
string
eg. You are not authorized to access this resource
Not Found - Resource does not exist or is not an admission request event
Response Fields
error
string
eg. not_found
error_description
string
eg. The requested resource was not found
Unprocessable Entity - Validation failed
Response Fields
error
string
Error message
errors
object
Field-specific validation errors
Show child attributes
value
array
eg. ["value is already in use on your account", "must be between 4 and 7 digits in length"]
Validation errors for the credential value
credential_type_id
array
eg. ["Not found for this account"]
Validation errors for the credential type
limit_reached
string
eg. You have reached your HID Mobile licence limit. Please contact DoorFlow Support.
License limit error message
Internal Server Error
Response Fields
error
string
eg. internal_server_error
error_description
string
eg. An unexpected error occurred