Skip to main content

Notifications subscriptions overview

Notifications subscriptions define when Eyer should deliver notification events for your environment.

Authentication

Use the standard bearer-token pattern described in Authorization details. These endpoints authorize against your environment and return only subscriptions for that environment.

Filter behavior

  • Each subscription includes a required filter
  • Filters determine which notification events are delivered to that subscription
  • Invalid filters are rejected when the subscription is created

For filter details and examples, see Notification filters overview.

Status lifecycle

  • New subscriptions are created with status: active
  • paused subscriptions do not deliver notifications until resumed
  • statusReason is manual when paused by the pause endpoint
  • statusReason is circuit_breaker when the system auto-pauses a subscription after 128 consecutive delivery failures over at least 24 hours

Configuration returned by the API

The list and create endpoints can return environment-level notification configuration data:

  • xNotificationToken is the token used on outbound notification requests
  • rsaKey.public is the public key used to verify signed notification requests

For verification guidance, see Verify notification deliveries.