A new alert was triggered

Threshold defined in the alert was crossed.

Request Body

application/json

Details of the triggered alert

TypeScript Definitions

Use the request body type in TypeScript.

idstringRequired

Unique identifier for the webhook event.

create_timestring<DateTimeWithZone>Required

Time when the webhook event was created.

Formatdate-time

event_versionstringOptional

Version of the event schema.

summarystringOptional

Brief description of the event.

resource_versionstringOptional

Version of the resource schema.

linksobject<Link>[]Optional

HATEOAS links for the webhook event.

resource_typeenum<ResourceType>Required

Type of resource that triggered the webhook.

event_typeenum<EventType>Required

Type of event that occurred in webhooks.

resourceobject<TriggeredAlertObject>Required

Response Body

Example Requests

POST/usage-billing.subscription-alert.triggered

Header Parameters

Request Body

application/json

Details of the triggered alert

TypeScript Definitions

Use the request body type in TypeScript.

idstringRequired

Unique identifier for the webhook event.

create_timestring<DateTimeWithZone>Required

Time when the webhook event was created.

Formatdate-time

event_versionstringOptional

Version of the event schema.

summarystringOptional

Brief description of the event.

resource_versionstringOptional

Version of the resource schema.

linksobject<Link>[]Optional

HATEOAS links for the webhook event.

resource_typeenum<ResourceType>Required

Type of resource that triggered the webhook.

event_typeenum<EventType>Required

Type of event that occurred in webhooks.

resourceobject<TriggeredAlertObject>Required

Header Parameters

Request Body

Link properties

TriggeredAlertObject properties

triggered_alert_AlertThreshold properties

Response Body

On this page

On this page

On this page

A new alert was triggered

Header Parameters

Request Body

Link properties

TriggeredAlertObject properties

triggered_alert_AlertThreshold properties

Response Body

On this page

On this page

A new alert was triggered

Header Parameters

Request Body

Link properties

TriggeredAlertObject properties

triggered_alert_AlertThreshold properties

Response Body

204

Request Bodyapplication/json

Header Parameters

On this page

On this page

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

A new alert was triggered

Header Parameters

Request Body

Link properties

TriggeredAlertObject properties

triggered_alert_AlertThreshold properties

Response Body

204

Request Bodyapplication/json

Header Parameters

On this page

On this page