Skip to main content
POST
Add an item to a alert

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Path Parameters

alertId
string<uuid>
required

Body

application/json
data
object
required

Response

200 - application/json

OK

id
string<uuid>
required
alertId
string<uuid>
required
scope
enum<string>
required
Available options:
base,
MX:AV,
MX:AV:ARI,
MX:AV:AVI,
MX:AV:INM,
MX:AV:JYS,
MX:AV:MJR,
MX:AV:MPC,
MX:AV:TSC,
MX:AV:VEH,
MX:CNBV,
MX:CNBV:TRANSMISOR,
MX
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
transactionId
string<uuid>

Transaction ID

clientId
string<uuid>

Client ID

metadata
object

Metadata

scopeData
object
clientNames
string[]
transactionAmount
number
transactionCurrency
string
transactionDate
string
validationErrors
object[]