Transaction Data APIAlerts

Update an existing transaction alert

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

AuthorizationstringRequired

Request

This endpoint expects an object.
alert_idstringRequired

Unique identifier for a alert belonging to a transaction. This is the primary key for a transaction alert and should be unique across all transaction alerts. Updates to a transaction alert should be made using this identifier.

timestampdatetimeRequired

The time of the transaction alert. This should be in ISO 8601 format. When adding a new transaction alert, this field represents the creation time. When updating a transaction alert, this represents the time of the update.

statusenumOptional
Allowed values:
check_typeenumOptional

The type of monitoring check that triggered the alert.

Allowed values:
related_check_idstringOptional

Unique identifier for a transaction check for which the alert belongs to.

additional_propertieslist of objectsOptional

Additional metadata that relates to a transaction alert.

Response

Transaction alert updated successfully

alert_idstring

Unique identifier for a alert belonging to a transaction. This is the primary key for a transaction alert and should be unique across all transaction alerts. Updates to a transaction alert should be made using this identifier.

timestampdatetime

The time of the transaction alert. This should be in ISO 8601 format. When adding a new transaction alert, this field represents the creation time. When updating a transaction alert, this represents the time of the update.

statusenumOptional
Allowed values:
check_typeenumOptional

The type of monitoring check that triggered the alert.

Allowed values:
related_check_idstringOptional

Unique identifier for a transaction check for which the alert belongs to.

additional_propertieslist of objectsOptional

Additional metadata that relates to a transaction alert.

Errors