PeriodicReviewChanged

webhook

periodicReviewChanged

Callback received each time the status of a periodic review changes or a follow-up is sent.

Payload

type

string

enum

required

The callback type

Show Details

0	Callback sent when a periodic review status changes or a follow-up is sent.

Allowed:

appUserId

string

required

User identifier from the Partner

requestedAt

date-time

required

When the current periodic review was requested

lastCompletedAt

date-time

required

When the last periodic review was successfully completed, if any

status

string

enum

required

Current periodic review status

Show Details

0	The periodic review has been initiated and is currently ongoing.
1	The periodic review deadline has passed and action is overdue.
2	The periodic review was not completed before the timeout deadline.
3	The periodic review has been successfully completed.

Allowed:

overdueAt

date-time

required

When the current periodic review becomes Overdue

timeoutAt

date-time

required

When the current periodic review becomes TimedOut

nextFollowUpAt

date-time

required

When the next follow-up is scheduled, if any

followUpsSentCount

string

required

Total number of follow-ups sent

Headers

Webhook-Id

uuid

required

UUID of the sent callback

Webhook-Processdate

date-time

required

Callback send date

Responses

202

Webhook received successfully.

204

Webhook received but consumer no longer interested.

410

Webhook endpoint is gone; subscription disabled.

Loading…