Skip to main content

Notification channels

The providers configured for each channel (e-mail, SMS, WhatsApp, voice), with their credentials and the per-message cost that feeds the usage metrics.

CommandHTTPDescription
notification-channels listGET /v1/notification-channelsList notification channels
notification-channels createPOST /v1/notification-channelsCreate notification channel
notification-channels getGET /v1/notification-channels/{id}Get notification channel
notification-channels updatePATCH /v1/notification-channels/{id}Update notification channel
notification-channels deleteDELETE /v1/notification-channels/{id}Delete notification channel

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 channels
kobana dunning notification-channels list --fields "id,channel_type,provider,status,cost_per_message"

# Configure the e-mail channel
kobana dunning notification-channels create \
--json '{"channel_type": "email", "provider": "sendgrid", "credentials": {"apiKey": "SG.xxxxx"}}'

# Remove a channel
kobana dunning notification-channels delete --params '{"id": "CHANNEL_ID"}' --dry-run

Next steps​