Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help-plum.xoxoday.com/llms.txt

Use this file to discover all available pages before exploring further.

​
⚠️ Important:

  1. This API must be implemented and hosted by the client.
  2. Xoxoday will consume this API whenever a redemption takes place.
  3. The request and response below are provided only as a sample to illustrate the structure that Xoxoday expects.
  4. Please ensure that your response is always in JSON format only, as our system does not support any other data types.

​
Sample Request and Response

​
Headers

  1. Content-Type: application/json

​
Sample Request

JSON (POST)
{
"unique_id":"DB123",
"auth_token":"asdgfjhbsdlkjbasdlkjbadslkbdakasdhfjhfdb=="
}

​
Sample Request Schema

ParameterTypeDescription
unique_idStringUnique identifier of a user (sent by Xoxoday in the SSO redirection request).
auth_tokenStringAuthorization value provided by the client during SSO redirection. Used by Xoxoday for API calls.

​
Sample Response

{
    "status": 1,
    "message": "Successfully loaded user's data",
    "user_data": {
        "unique_id": "22816281",
        "company_email_id": "dwightschrute@dundlermifflin.com",
        "first_name": "Dwight",
        "last_name": "Schrute",
        "mobile_number": "+1-123456789"
    }
}

​
Schema Response Schema

ParametersDescription
status1 = successful / 0 = failure
user_data.unique_idUnique identifier of the user
user_data.company_email_idEmail address of the user
user_data.first_nameFirst name of the user
user_data.last_nameLast name of the user
user_data.mobile_numberMobile number of the user

​
Implementation Notes

  1. Xoxoday will only consume this API — the client must build and expose it.
  2. The auth_token must be provided by you under tpd object when SSO Redirection API is called .
  3. Make sure the API response includes accurate response status.