Get notification routing

GET

/api/v1/config/notification-routing

const url = 'http://localhost:11044/api/v1/config/notification-routing';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/config/notification-routing \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Per-user notification routing: per-tier channels + quiet hours. Null tierChannels = inherit deployment defaults.

Authorizations

apiKeyAuth
basicAuth

Responses

200

Notification routing config

*/*

The user’s notification routing: which channels each urgency tier reaches, and their quiet hours. Stored in the world config; read by GET /config/notification-routing and part of GET /config

object

quietHours

The user’s quiet-hours window, replacing the deployment one; null inherits the deployment window

object

enabled

required

Whether the window is applied; false means no quiet hours for this user, even when the deployment has them

boolean

end

required

End of the window, HH:mm local time, inclusive

string

start

required

Start of the window, HH:mm local time; a window whose start is after its end runs past midnight

string

tierChannels

required

Urgency tier name (AMBIENT, DEFERRED, TIMELY, INTERRUPTIVE, ACTING, ESCALATING) to the channel kinds it reaches, such as vaadin, telegram, discord or sms. A tier present here replaces the deployment default for that tier; an absent tier inherits it

object

key

additional properties

Array<string>

unique items