TRtraversal
organization-admin

Update New Session Alert Config

Changed on

Turn the alert on or off for one organization.

Platform admin only. Synchronous rather than routed through UpdateOrganizationWorkflow like the sibling PUT: enabling validates the channel against Slack for real, and the admin needs that outcome in the response.

put/admin/organizations/{organization_id}/new-session-alert

Request

  • Base URL
    https://api.traversal.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.traversal.com/admin/organizations/{organization_id}/new-session-alert
  • Auth
    none declared

Path parameters

organization_idstring required

Request body

enabledboolean required
channel_namestring nullable

Channel name to alert into, with or without a leading #

excluded_emailsstring[]

Response

Successful Response

enabledboolean required

Off unless a platform admin has turned it on

channel_namestring nullable

Configured channel name, without the leading #

channel_idstring nullable

Resolved Slack channel ID

suggested_channel_namestring required

Convention-based default to pre-fill when nothing is configured

excluded_emailsstring[]

Addresses that should never raise an alert, e.g. teammates on personal mail

bot_is_memberboolean nullable

Live membership of the configured channel; None when none is resolved

Changes