Notification channels in AI Cost Management

Uses: AI Cost Management AI Gateway Konnect API

What is a notification channel?

A notification channel is a destination for budget alerts in AI Cost Management. Use channels to send each budget’s alerts where the right people will see them, for example an email list for finance and a Slack channel for the team that owns the budget.

You only need to create a channel once, then list it in the notification rule of any budget.

One channel can serve many budgets, and a rule can list up to 10 channels. A channel has a name of 1 to 100 characters and optional labels. Several channels can share a name.

Channel types

AI Cost Management supports the following channel types:

Email: AI Cost Management sends one message to each recipient address. A channel holds 1 to 10 addresses. Each address can appear only once, ignoring case.
Slack: AI Cost Management posts the message to the Slack incoming webhook URL, which you create in your own Slack workspace. The channel accepts only Slack incoming webhook URLs.

When you replace a Slack channel, you can omit slack.webhook_url to keep the stored URL.

Set up a notification channel

To create an email or Slack channel:

In the Konnect sidebar, click Cost Management.
In the Cost Management sidebar, click Budgets.
Click the Channels tab.
Click New channel.
In the Name field, enter a name for the channel.
From the Channel type dropdown menu, select “Email” or “Slack”.
Enter the delivery details for the channel type:
- For an email channel, in the Recipients field, enter an email address. Repeat for each address that should receive alerts.
- For a Slack channel, enter the webhook URL from your Slack incoming webhook.
Click Create channel.

To create an email channel, send a POST request to the /v1/ai-cost-management/notification-channels endpoint. Replace YOUR_EMAIL_ADDRESS with the address that should receive alerts:

curl -X POST "https://us.api.konghq.com/v1/ai-cost-management/notification-channels" \
     --no-progress-meter --fail-with-body  \
     -H "Authorization: Bearer $KONNECT_TOKEN"\
     -H "Content-Type: application/json"\
     -H "Accept: application/json, application/problem+json" \
     --json '{
       "name": "budget-alerts-email",
       "type": "email",
       "email": {
         "recipients": [
           "'$YOUR_EMAIL_ADDRESS'"
         ]
       }
     }'

Copied!

To create a Slack channel, send a POST request to the /v1/ai-cost-management/notification-channels endpoint with the slack type. Replace YOUR_SLACK_WEBHOOK_URL with the webhook URL from your Slack incoming webhook:

curl -X POST "https://us.api.konghq.com/v1/ai-cost-management/notification-channels" \
     --no-progress-meter --fail-with-body  \
     -H "Authorization: Bearer $KONNECT_TOKEN"\
     -H "Content-Type: application/json"\
     -H "Accept: application/json, application/problem+json" \
     --json '{
       "name": "budget-alerts-slack",
       "type": "slack",
       "slack": {
         "webhook_url": "'$YOUR_SLACK_WEBHOOK_URL'"
       }
     }'

Copied!

The response includes the id of the channel, which you list in a budget’s notification rule.

Test a notification channel

To check a channel before you attach it to a budget, send it a test message. The test message looks like an alert, with test wording and example figures. Its title is Test message from channel "<name>", with the name of the channel. AI Cost Management sends the test within seconds and records the outcome as a notification event.

To test a channel, send a POST request to the /v1/ai-cost-management/notification-channels/{channelId}/tests endpoint. Replace CHANNEL_ID with the id of the channel:

curl -X POST "https://us.api.konghq.com/v1/ai-cost-management/notification-channels/$CHANNEL_ID/tests" \
     --no-progress-meter --fail-with-body  \
     -H "Authorization: Bearer $KONNECT_TOKEN"

Copied!

The response is the notification event that records the test. To read the outcome, get the event with the /v1/ai-cost-management/notification-events/{eventId} endpoint. When a channel already has a pending test, a new request returns that test instead of queueing another.

Notification channels in AI Cost Management

What is a notification channel?

Channel types

Set up a notification channel

Test a notification channel

Schema

Help us make these docs great!

Still need help?