SubscriberAccess

August 7, 2026 ยท View on GitHub

Controls whether the agent accepts inbound messages from senders not yet linked to a subscriber, across all channels. "open" on managed agents auto-creates a lightweight subscriber so the agent can reply; on custom-code / self-hosted agents, the turn is forwarded to the bridge with a null subscriber. "restricted" rejects unknown senders with a managed denial reply (any runtime). Optional on update (partial PATCH). Persisted agents always have a value โ€” managed create defaults to "open"; self-hosted create defaults to "restricted".

Example Usage

import co.novu.models.components.SubscriberAccess;

SubscriberAccess value = SubscriberAccess.OPEN;

// Open enum: use .of() to create instances from custom string values
SubscriberAccess custom = SubscriberAccess.of("custom_value");

Values

NameValue
OPENopen
RESTRICTEDrestricted