Skip to main content
POST
/
events
/
custom
Log custom event
curl --request POST \
  --url http://sandbox.mintlify.com/events/custom \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventType": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "source": "<string>",
  "data": {},
  "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

Custom event details

​
eventType
string
required

Custom event type identifier

​
timestamp
string<date-time>
required

When the event occurred

​
source
string

Source system or application

​
data
object

Custom event payload

​
metadata
object

Additional event metadata

Response

201 - application/json

Custom event logged

​
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