REresilio
Notifications

Get notification by id

Returns notification info.

get/notifications/{id}

Request

  • Base URL
    https://localhost:8446/api/v2
  • Auth
    API key in header Authorization

Path parameters

idnumber required

Notification id

Response

Successful response

idnumber required

Notification id

typestring required

Notification type

destinationsobject required

Array of notification destinations

destinations.emailstring

Email to send notifications

destinations.user_idnumber

Id of user to send notifications

destinations.web_hook_idnumber

Id of webhook to send notifications

job_idnumber

Job id. Is null in case of notification is configured for any job. Only for job notifications

triggerstring

Notification trigger. Only for job notifications

settingsobject required

Notification settings

settings.error_codestring

Error code to trigger notification. Is null in case of notification is configured for any error code. Only for job notifications and JOB_RUN_ERROR trigger

settings.notify_after_error_timeoutboolean

Trigger notification after error timeout. Only for job notifications and JOB_RUN_ERROR trigger

settings.error_timeoutnumber

Error timeout (seconds). Only for job notifications and JOB_RUN_ERROR trigger. Minimum value is 1 minute

settings.notify_on_error_removeboolean

Notify when error is resolved. Only for job notifications and JOB_RUN_ERROR trigger

settings.complete_timeoutnumber

Send notification if job run isn't complete within time wait period (seconds). Only for job notifications and JOB_RUN_NOT_COMPLETE trigger. Minimum value is 1 minute

settings.dont_send_if_no_data_transferredboolean

Skip notice if jobs did not transfer files. Only for job notifications and JOB_RUN_FINISHED trigger

settings.eventstring

Event to trigger notification. Only for event notifications

settings.weeklyboolean

Send notification weekly (every Monday). Only for overview notifications

settings.dailyboolean

Send notification daily. Only for overview notifications

settings.send_time_dailynumber

Send daily overview notification as specified number of seconds since midnight passes. Default value is 0 seconds

settings.send_time_weeklynumber

Send weekly overview notification as specified number of seconds since midnight passes. Default value is 0 seconds.

Changes

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