NEnexla
Notifications

List Notification Settings

This endpoint lists all notification settings in the authenticated user's account.

Notification settings contain the following user settings:

  1. Whether the user wants to be notified about a specific event (status of a notification_type on a notification_resource_type)
  2. If yes, on what channel the user wants to be notified
  3. The configuration of the channel (notification_channel_setting_id)
  4. Configuration parameters affect when the notification should be fired. This is usually left empty to use platform defaults, but it is relevant when users want to override the default settings of some notifications, such as Source Data Delayed
get/notification_settings

Request

Query parameters

event_type'SHARE' | 'CREATE' | 'DELETE' | 'UPDATE' | 'ACTIVATE' | 'PAUSE' | 'METRICS' | 'RESETPASS' | 'ERROR_AGGREGATED' | 'ERROR' | 'MONITOR' | 'WRITE' | 'EMPTY_DATA' | 'READ_START' | 'READ_DONE' | 'WRITE_START' | 'WRITE_DONE'
resource_type'ORG' | 'USER' | 'DATA_FLOW' | 'CUSTOM_DATA_FLOW' | 'SOURCE' | 'DATASET' | 'SINK'
status'PAUSED' | 'ACTIVE'

Whether or not the user should be notified about this event for this resource on the selected channel.

Response

Success

idinteger
org_idinteger
owner_idinteger
channel'APP' | 'EMAIL' | 'SMS' | 'SLACK' | 'WEBHOOKS'
notification_resource_type'ORG' | 'USER' | 'DATA_FLOW' | 'CUSTOM_DATA_FLOW' | 'SOURCE' | 'DATASET' | 'SINK'
resource_idinteger
configobject
priorityinteger
status'PAUSED' | 'ACTIVE'

Whether or not the user should be notified about this event for this resource on the selected channel.

notification_type_idinteger
namestring
descriptionstring
codeinteger
categorystring
event_type'SHARE' | 'CREATE' | 'DELETE' | 'UPDATE' | 'ACTIVATE' | 'PAUSE' | 'METRICS' | 'RESETPASS' | 'ERROR_AGGREGATED' | 'ERROR' | 'MONITOR' | 'WRITE' | 'EMPTY_DATA' | 'READ_START' | 'READ_DONE' | 'WRITE_START' | 'WRITE_DONE'
resource_type'ORG' | 'USER' | 'DATA_FLOW' | 'CUSTOM_DATA_FLOW' | 'SOURCE' | 'DATASET' | 'SINK'

Changes

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