Skip to main content
POST
/
events
/
account-activity
Log account activity event
curl --request POST \
  --url http://sandbox.mintlify.com/events/account-activity \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "<string>",
  "eventType": "balance_check",
  "timestamp": "2023-11-07T05:31:56Z",
  "metadata": {}
}
'
{
  "eventId": "<string>",
  "status": "success",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Account activity event details

accountId
string
required

Unique identifier for the account

eventType
enum<string>
required

Type of account activity (e.g. balance_check, statement_download)

Available options:
balance_check,
statement_download,
profile_update,
settings_change
timestamp
string<date-time>
required

Time when the event occurred

metadata
object

Additional event-specific details

Response

Event logged successfully

eventId
string
required

Unique identifier for the logged event

status
enum<string>
required

Status of the event logging

Available options:
success,
failed
timestamp
string<date-time>

Time when the event was logged