internal

List Notification Types

The catalog of notification types with their default and required permission.

get/internal/notifications/types

Response

Successful Response

notification_typestring required
labelstring required
descriptionstring required
default_enabledboolean required
required_permissionstring nullable required
supports_assigned_scopeboolean required
assigned_scope_labelstring nullable required
default_scope'all' | 'assigned' required

How widely a user wants to receive a (scope-supporting) notification.

ALL means every event of this type at the company; ASSIGNED narrows it to the subset that concerns the user. What "assigned" resolves to is defined by the definition's AssignedScopeSpec.kind.

Changes

No recorded changes to this endpoint across all 1 revision of this API.