Membership Period Regret

Event name membershipPeriod_regret

This webhook is triggered when a membership period is regretted - the valid until date is changed with intent to end the membership prematurely. Use the Get Membership History endpoint to retrieve full details about the membership’s validity periods.

Payload

The payload of this webhook request is an object.
appIdUUIDRequired
clientStatestringRequired
companyIdUUIDRequired
companyNamestringRequired
eventNamestringRequired
eventVersionstringRequired
initiatingUserAADObjectIdstringRequired
payloadobjectRequired
timestampdatetimeRequired

Response

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