Notify on new sharing
- Type
- notify_on_new_sharing
- Category
- Operational
- Enforced atWhen this policy is checked: while someone tries to open, while they create or change an invitation or hold, or after a denial (notify only).
- Authoring-time
- TiersWhere an admin can set this policy: the whole organization, one integration, or the physical device when the connector supports a device steward.
- OrgIntegration
- EnforcementHow a configured row behaves. Enforce blocks. Require approval opens an admin inbox when the type supports it. Audit only records and never blocks.
- Enforce
- DefaultWhat happens when no row of this type is configured.
- Not configured — new sharing is not additionally notified.
An authoring-time hook after a successful share. It fires after users_admin writes other than list_users, and after invitation create that actually shares access. Emit audit only when channels includes audit. This type does not itself block sharing. Only `audit` is accepted on write.
When it is enforced
Evaluated when someone creates or updates an invitation, hold, or share. Requests that would exceed the limit are rejected — they are not silently rewritten.
Where to set it
Settings → Policies (org) or the integration Policies tab.
Policies never grant access. See thepolicies architecture guidefor how org, integration, and device tiers combine.
Arguments
The config object on create/update. Shared row fieldsenforcement (enforce, require_approval,audit_only) and enabled apply to every type;audit_only and disabled rows never block.
| Name | Type | Required | Values | Description |
|---|---|---|---|---|
| channels | string[] | Yes | audit | Destination channels. Only `audit` is accepted until another channel exists. Unknown names and empty arrays are rejected. Default: ["audit"] (dashboard) |
| output | string or integer | No | — | Optional channel or output id. When set, the policy binds only that output. When omitted, it binds every output of the tier target. A scoped row does not apply when the acting output is unknown. |
How overlapping rows combine
Union of channels across applicable rows. Emit audit only when "audit" is present.
Example
Adding a gate user or creating an invitation that shares a portal records a new-sharing audit event. Listing vendor users does not.
{ "channels": [ "audit" ]}Integrations
This type is documented on these connectors:
- Home Assistant (home_assistant)
- KNX (knx)
- MQTT (mqtt)
- PalGate Cloud (palgate_cloud)
- Shelly Cloud (shelly_cloud)
- Shelly Websocket (shelly_websocket)
- Tasmota (tasmota)
- Virtual Access (virtual_access)
- Virtual Demo Devices (virtual_demo)
- Waveshare (waveshare)
Related
- Policy catalog
- Policies architecture guide
- Notify on first use (notify_on_first_use)
- User sharing control (user_sharing)
- Approval threshold (approval_threshold)
Typed configuration
Section titled “Typed configuration”The OpenAPI contract names this object NotificationPolicyConfig:
{ "channels": ["audit"], "output": "main"}Only audit is currently accepted in channels; this policy records successful sharing activity and does not block sharing.