Notifications

Get a notification and its delivery attempts

GET/v1/notifications/{id}
Authentication
API key (Authorization: Bearer)
Required scope
read

Path parameters#

  • idstring · uuidrequired

Responses#

200Notification.
Object fields
  • idstring · uuid
  • channel_idstring · uuid
  • channel_kindstring
    Values webhook discord slack email telegram hellome
  • kindstring

    alert, digest, test, security, summary, service.

  • stagestring

    Step of the alert: unconfirmed (seen before confirmations), confirmed, cancelled (removed by a chain reorganization), escalation; or the kind of message for non-alert notifications.

    Values unconfirmed confirmed cancelled escalation digest test security summary service
  • statusstring
    Values queued sending sent failed grouped
  • priorityinteger
  • rule_idstring · uuidnullable
  • match_idstring · uuidnullable
  • digest_idstring · uuidnullable

    Digest that counted this grouped alert.

  • attemptsinteger
  • next_attempt_atstring · date-timenullable
  • sent_atstring · date-timenullable
  • failed_atstring · date-timenullable
  • last_errorstringnullable
  • titlestring

    First line of the message.

  • textstring
  • created_atstring · date-time
  • delivery_attemptsarray of object

    Newest first, 100 at most.

    Fields of each item
    • attemptinteger
    • okboolean
    • status_codeintegernullable
    • duration_msinteger
    • errorstringnullable
    • atstring · date-time
4xx · 5xxError.

Standard error format: see Errors.