Skip to main content
This guide covers information on webhook events and client category triggers.

​
Client category triggers descriptions

Client category triggersDescription
Client added two factor authClient enables two-factor authentication
Client consolidation invoices dispatchedConsolidated invoices sent
Client deletedClient account deleted
Client logged inClient logged in
Client login email updatedLogin email updated
Client login username updatedUsername updated
Client password changedPassword changed
Client password was resetPassword reset by staff
Client removed two factor authTwo-factor authentication disabled
Client updatedClient details updated
Client was impersonatedStaff impersonated client
New client support pinNew support PIN generated
Staff created verified clientStaff created verified client
Client exceeded max incorrect loginsMax login attempts exceeded
Client login disabledLogin disabled
Client login enabledLogin enabled
Client notification emails disabledNotification emails disabled
Client password setup required after importPassword setup required after import
Client registeredClient registered
Client requested password resetPassword reset requested by client
Client verification requiredVerification required
Client wallet balance adjustedWallet balance adjusted
Staff created unverified clientStaff created unverified client

​
Webhook client event triggers

​
Adding or updating a client

Category: ClientTriggers:
  • Client registered
  • Staff created verified client
  • Staff created unverified client
  • Client updated
Description: Covers all scenarios where a client is added or updated, whether by self-registration or staff action.

​
Client security and authentication

Category: ClientTriggers:
  • Client added two_factor auth
  • Client removed two factor auth
  • Client password changed
  • Client password was reset
  • Client requested password reset
  • Client password setup required after import
  • Client exceeded max incorrect logins
  • Client login disabled
  • Client login enabled
Description: Tracks all security-related actions for client authentication and access.

​
Client login and account access

Category: ClientTriggers:
  • Client logged in
  • Client login email updated
  • Client login username updated
  • Client was impersonated
Description: Captures login activity, credential changes, and impersonation by staff.

​
Client verification and communication

Category: ClientTriggers:
  • Client verification required
  • New client support pin
  • Client notification emails disabled
Description: Monitors verification processes and communication preferences.

​
Client account status and wallet

Category: ClientTriggers:
  • Client deleted
  • Client consolidation invoices dispatched
  • Client wallet balance adjusted
Description: Handles account deletions, consolidated billing, and wallet adjustments.