API ReferenceTransaction Alerts

Add new transaction alert(s)

Authentication

AuthorizationBearer

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

Request

Transaction alert data to add.
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.
timestampstringRequiredformat: "date-time"
When this alert was generated in your system, in ISO 8601 format.
check_typeenumOptional
The type of monitoring check that triggered the alert.
Allowed values:
is_testbooleanOptionalDefaults to false
If the transaction alert is test data, this should be set to true
related_check_idstringOptional
Unique identifier for a transaction check for which the alert belongs to.
related_tx_idslist of stringsOptional
Unique identifiers for transactions which the alert relates to.
statusenumOptional
Allowed values:

Response

Transaction alert added successfully
successboolean
Indicates if the write operation was successful.
write_countinteger
The number of records written to the database.
messagestring
Provides additional information about the operation result.
organization_idstring
The organization ID for which the operation was performed.

Errors