User State Update

Occurs whenever a user’s state is updated

Headers

x-flagright-signaturestringRequired

An HMAC SHA256 signature generated using the webhook payload and a shared signing secret. This is then converted to a hex encoded string.

Payload

The payload of this webhook request is an object.

createdTimestampdoubleRequired

Time at which the event was created. Measured in ms since the Unix epoch.

dataobjectRequired

idstringRequired

Unique identifier for the event

triggeredBy"MANUAL" or "SYSTEM"Required

Allowed values: MANUALSYSTEM

Event triggered by a user or system

type"USER_STATE_UPDATED"Required

Response

200

any

Return a 200 status to indicate that the data was received successfully.

Payload

1 {
2   "createdTimestamp": 1,
3   "data": {
4     "state": "UNACCEPTABLE",
5     "reason": "string"
6   },
7   "id": "string",
8   "triggeredBy": "MANUAL",
9   "type": "USER_STATE_UPDATED"
10 }

Payload

1 {
2   "createdTimestamp": 1,
3   "data": {
4     "state": "UNACCEPTABLE",
5     "reason": "string"
6   },
7   "id": "string",
8   "triggeredBy": "MANUAL",
9   "type": "USER_STATE_UPDATED"
10 }