Skip to main content

Notifications

Every message sent to a customer — by a rule or manually — with its delivery status. resend creates a new notification from one that failed (failed or bounced).

CommandHTTPDescription
notifications listGET /v1/notificationsList notifications
notifications createPOST /v1/notificationsCreate notification
notifications getGET /v1/notifications/{id}Get notification
notifications updatePUT /v1/notifications/{id}Update notification
notifications deleteDELETE /v1/notifications/{id}Delete notification
notifications resendPOST /v1/notifications/{id}/resendResend notification

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.

# Failed notifications
kobana dunning notifications list \
--params '{"status": "failed"}' \
--fields "id,person_id,charge_id,channel,status,recipient"

# Resend a notification
kobana dunning notifications resend --params '{"id": "NOTIFICATION_ID"}'

# Delete a notification
kobana dunning notifications delete --params '{"id": "NOTIFICATION_ID"}' --dry-run

Next steps​