/app/user/events

This API will give list of events in which a particular user has participated.

URL

• Prod: https://api.fyre.hypersign.id/ext/api/v1/app/user/events

• Stage: https://stage.hypermine.in/whitelist/ext/api/v1/app/user/events

Method

POST

Headers

"Content-Type": 'application/json',
"Origin": <base URL> // Registered Base URl 

Request Body

Every request body must contain three properties: message, fyresign and messageHash.

Sample request body:

{
  "message":{  
   "appId": "6274a30fc43e05144642a484", 
   "externalUserId":"456fhioghtuht374", 
   "iat": 1651814836,
   "exp": 1651901236,
   "metaData":{ 
       "limit":10,
       "page":1
     }
  },
  "fyresign": "0xe4373eb48fdf488dad6b69261963c5e556b3316594695d03668e4eb61673620c5e1d516bccdc0297ca139a11b5daf88fe88f40586a4d97d6dbbb94978e64f4d51b",
  "messageHash":"0xe2f8fg53207a97b56a1aa8edf68f94fa019fa8a8f627be8fe451bb77546b58a306"
}

• message

  • appId: Id that you will get after creating app in Fyre Admin Dashboard.

  • externalUserId: Identifier for the user on application's platform which will be mapped with Fyre user Id.

  • iat: Timestamp at which the message was signed.

  • exp: Timestamp upto which the signature is valid.

  • metaData: This field is to send extra parameter like limit, page values.

• fyresign: Signature generated by signing message using app's private key. Send generated signature in this field.

• messageHash: Hash of the message.

Response Body

{
  "message": "Successfully fetched userEvents",
  "data": [
    {
       "_id": "6274b4cde7556226721e620c",             // eventId
      "projectName": "Test Event",                    // Name of the event
      "logoUrl": "http://localhost:3000/img/logo.png", 
      "fromDate": "2022-05-06T05:40:00.000Z",         // Event start date
      "toDate": "2023-05-18T05:40:00.000Z",           // Event end date
      "projectStatus": true,                          // Event status Closed | Open
      "slug": "test-event",
      "eventActionsCount": 3,                         // Number of action configured in this event 
      "performedActionsCount": 1                      // Number of actions performed by the user 
      "actions":[{                                    // User actions list
            "_id":"6298daf0b253e14768b3548d",         // Action id
            "eventId":"6298daefb253e14768b35481",     // Event id 
            "order":1,                                // Order in which action is will appear in the UI
            "type":"HYPERSIGN_AUTH",                  // Action Type;  See the full list of supported types in /apis/event-action-types page
            "title":"Hypersign Authentication",       // Action title
            "score":5,                                // Score user gets for the action
            "isManadatory":true,                      // Is action mandatory
            "value":"Authorized",                     // Action value when user preforms the action 
            "placeHolder":"Hypersign Authentication",  
            "__v":0
        }]
    },
  ],
  "success": true,
  "error": false
}

NOTE: See the full list of supported action types in Event Action Types page;