For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
An array of transaction alert update payloads. Each payload must include the ‘alert_id’ to identify the alert and can include any other fields that need to be updated. The ‘timestamp’ field represents the time of update.
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
When this alert was generated in your system, in ISO 8601 format.
is_testbooleanOptionalDefaults to false
If the transaction alert is test data, this should be set to true
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.
related_tx_idslist of stringsOptional
Unique identifiers for transactions which the alert relates to.
Response
Transaction alert updated 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.
