Skip to main content
POST
Create report notification

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Create a ReportNotification.

title
string
required

The title of the ReportNotification.

cost_report_token
string
required

The CostReport token.

frequency
string
required

The frequency the ReportNotification is sent. Possible values: daily, weekly, monthly.

change
string
required

The type of change the ReportNotification is tracking. Possible values: percentage, dollars.

workspace_token
string

The token of the Workspace to add the ReportNotification to. Required if the API token is associated with multiple Workspaces.

user_tokens
string[]

The Users that receive the notification.

recipient_channels
string[]

The Slack or Microsoft Teams channels that receive the notification.

Response

ReportNotification model

token
string
required
title
string
required

The title of the ReportNotification.

Example:

"Acme Report Notification"

cost_report_token
string
required

The token for a CostReport the ReportNotification is applied to.

Example:

"rprt_abcd1234"

user_tokens
string[]
required

The Users that receive the notification.

recipient_channels
string[]
required

The Slack or Microsoft Teams channels that receive the notification.

frequency
enum<string>
required

The frequency the ReportNotification is sent.

Available options:
daily,
weekly,
monthly
Example:

"weekly"

change
enum<string>
required

The type of change the ReportNotification is tracking.

Available options:
percentage,
dollars
Example:

"percentage"