Overview
The Client Status Change Webhook triggers when a client’s status changes to one of the predefined states, such as introOffer, activePackage, suspendedMembership, or inactive. This webhook helps ensure that your systems are always current with the latest client status, enabling automated responses based on these status changes.
Trigger Event:
-
Fired when a client’s status changes to one of the predefined states.
Event Type:
-
clientStatusChange
Payload Details:
-
clientID: Unique identifier for the client.
-
siteID: Identifier for the site associated with the client.
-
firstName: Client’s first name.
-
lastName: Client’s last name.
-
email: Client’s email address.
-
phone: Client’s phone number.
-
status: The new status of the client (e.g., activePackage, suspendedMembership).
-
activePackages: List of active packages tied to the client, including:
-
packageID: Unique identifier for the package.
-
packageName: Name of the package.
-
packageCategory: Category of the package.
-
Usage Example:
-
Automatically update a client’s status in your system to reflect changes such as membership renewal, suspension, or expiration.
-
Trigger automated communications to clients when their status changes, such as reminders to renew an expiring membership.
Payload response example:
Below is an example of the JSON payload that might be received when the Client Status Change Webhook is triggered: