Forgot Password: eventForgotPassword

The Forgot Password event API tracks the process when a customer initiates a password reset. It captures the links and actions related to resetting the customer's password.

API Endpoint and Method

URL

https://sandbox.algonomy.com/callback/rest/events/{APP_API_KEY}/eventForgotPassword

Example URL

https://sandbox.algonomy.com/callback/rest/events/ABCDILOBZCGHVLZTCNTGJMYGQEARWVZVCUPYVUGNCZPJRSUDAR/eventForgotPassword

HTTP Method

POST

Parameters

Parameter	Type	Required or Optional	Description
forgotPwdPrimaryLink	String	Optional	Specifies the password primary link. Example: "https://testlink.com/wewe-3424"
forgotPwdSecondaryLink	String	Optional	Specifies the password secondary link. Example: "https://testlink.com/wewe-3424"
newPwd	String	Optional	Specifies the new password. Example: "@#ASD^099G"

Parameter

Type

Required or Optional

Description

forgotPwdPrimaryLink

String

Optional

Specifies the password primary link.

Example: "https://testlink.com/wewe-3424"

forgotPwdSecondaryLink

String

Optional

Specifies the password secondary link.

Example: "https://testlink.com/wewe-3424"

newPwd

String

Optional

Specifies the new password.

Example: "@#ASD^099G"

Request Body Schema

{
   "eventData":{
      "forgotPwdPrimaryLink":"String",
      "forgotPwdSecondaryLink":"String",
      "newPwd":"String"
   }
}

Example Request

{
   "eventData":{
      "forgotPwdPrimaryLink":"https://testlink.com/wewe-3424",
      "forgotPwdSecondaryLink":"https://testlink.com/wewe-3424",
      "newPwd":"@#ASD^099G"
   }
}

Example Response

{
"status": "success",
"message": "Forgot password event captured successfully."
}

HTTP Response Codes

Response Code	Description
202 Accepted	The request has been received and validated, but processing is asynchronous and not yet complete.