1. API Reference
  2. API resources
  3. Messages
Website
  • API overview
  • API quickstart
  • Authentication
  • Project scoping
  • Requests and responses
  • Pagination and filtering
  • Errors
  • GETList supported database engines
  • POSTList projects
  • POSTCreate a project
  • GETGet a project
  • DELETEDelete a project
  • PATCHUpdate a project
  • POSTCreate a source
  • POSTList sources
  • GETGet source details
  • DELETEDelete a source
  • PATCHUpdate a source
  • POSTCreate secret metadata
  • POSTList secret metadata
  • GETGet secret metadata
  • DELETEDelete secret metadata
  • PATCHUpdate secret metadata
  • POSTCreate a schedule
  • POSTList schedules
  • POSTSummarize schedule statuses
  • GETGet a schedule
  • DELETEDelete a schedule
  • PATCHUpdate a schedule
  • DELETERemove a schedule gate
  • POSTActivate or pause a schedule
  • POSTQueue a manual check
  • POSTCreate an immutable report
  • POSTList reports
  • GETGet report details
  • DELETEDelete a report
  • POSTDownload a report
  • POSTGet the API-key scope catalog
  • POSTCreate an API key
  • POSTList API-key metadata
  • GETGet API-key metadata
  • DELETEDelete an API key
  • PATCHUpdate API-key metadata
  • POSTCreate a notification channel
  • POSTList notification channels
  • POSTResolve notification channels by ID
  • GETGet notification channel details
  • DELETEDelete a notification channel
  • PATCHUpdate a notification channel
  • POSTSend a test notification
  • POSTCreate a project worker
  • POSTList project workers
  • GETGet worker details
  • DELETEDelete a worker
  • PATCHUpdate a worker
  • POSTRead live worker agent logs
  • POSTList checks
  • POSTSummarize check statuses
  • GETGet check details
  • POSTGet check log sections
  • POSTDownload a check log
  • POSTDownload check audit evidence
  • POSTList notification messages
  • GETGet notification message details

Messages

Inspect read-only notification delivery records for checks and channel tests.

Loading documentation…

Notification channels< PreviousWorkersNext >

Powered by heyo

On this page

Delivery fieldsFilter messagesEndpoint reference

Messages record notification delivery attempts created by check notifications or channel test runs. They are read-only through the customer API.

Delivery fields

A message includes its status, kind, related check, schedule, and channel IDs, timestamps, retry count, and delivery detail. Current statuses are queued, processing, success, failed, and dead; kinds are check and test.

List responses enrich rows with channel and schedule names when those resources still exist in the same project.

Filter messages

List filters support:

  • channel_id
  • check_id
  • status
  • kind

Use v1.messages:read for both list and detail operations.

Endpoint reference

  • List messages
  • Get message details

Related topics

  • Configure notification channels
  • Inspect the related check
  • Paginate delivery records