Skip to main content

Notifications

The notifications the platform sends by e-mail (or in-app and by webhook), with each one's status. send sends a scheduled notification now or sends it again; stats list returns counts and delivery and read rates.

CommandHTTPDescription
notifications listGET /v1/notificationsList notifications
notifications createPOST /v1/notificationsCreate notification
notifications sendPOST /v1/notifications/{id}/sendSend notification
notifications stats listGET /v1/notifications/statsNotification statistics

Examples​

--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List notifications
kobana dashboards notifications list \
--params '{"status": "failed"}' \
--fields "id,type,recipient,status,failure_reason"

# Send notification
kobana dashboards notifications send --params '{"id": "NOTIFICATION_ID"}'

# Notification statistics
kobana dashboards notifications stats list --params '{"days": 30}'

Next steps​