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

Password reset event details

​
userId
string
required

Unique identifier for the user

​
requestId
string
required

Unique identifier for the password reset request

​
timestamp
string<date-time>
required

Time when the password reset was initiated

​
status
enum<string>

Current status of the password reset

Available options:
initiated,
email_sent,
completed,
expired,
cancelled
​
expiresAt
string<date-time>

When the reset token expires

​
metadata
object

Additional reset-specific details

Response

201 - application/json

Password reset initiated and 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