Occurrences

Last Updated: 2023-10-29 02:00:20
The members plugin adds registration abilities to your website and manages a users login session.  Depending on the configuration and how your system is setup, not all notifications will trigger.  Members supports the following occurrences/notifications.
    
Note: Not all Members notifications are suitable for API callbacks, most are intended for email notifications.
    
members.registrations & members.registrations.reset
The members.registrations notification is triggered when a new member signs up to your website.  If you are using API callbacks to synchronize registrations with another system and you've enabled account verification then use this notification with members.accounts activate to complete a registration.

The members.registrations.reset notification is triggered if an administrator resets the password on an account.  This notification is really just intended for email communication between your and your account holder.

The following data is available and shared between these occurrences for email templates and API callback parameters.

[ 'AccountId', 'Email', 'FirstName', 'LastName', 'Phone', 'Address', 'City', 'Region', 'PostalCode', 'Country', 'Temporary', 'Recipient', 'UserName', 'Password' ]

Note: Not all of the variables will have values as this depends on how your system is setup.
       
members.accounts.activate
This notification is available when the website is setup to verify new members ( email activation ).  It's triggered when an account activation is requested.

The following data is available for your email templates and is passed as your API callback parameters.

[ 'DomainIdentifier', 'TargetLocation', 'PrimaryLanguage', 'CurrencyCode', 'SiteTheme', 'ScriptDirection', 'DomainUrl', 'ComponentUrl', 'Recipient', 'Token', 'AccountId', 'FirstName', 'LastName' ]

If you are synchronizing account data to another platforms and using account verification then use this notification to complete a registration.

members.accounts.password
This notification is triggered when a user resets their account password and enters the forgot password process.  This occurrence is not suitable for API callbacks as it wouldn't serve any purpose.

The data available for email templates and API callbacks is the same as members.accounts activate.

members.accounts.deactivated & members.accounts.suspended
The members.accounts.deactivated notification is triggered when a user account gets deactivated.  This usually occurs when too many failed sign in attempts are made.

The members.accounts.suspended notification is triggered when a user account gets suspended. This usually occurs when a lot of failed sign in attempts occur.

The following data is available for your email templates and is passed as your API callback parameters.

[ 'AccountId', 'FirstName', 'LastName', 'Created', 'Recipient ]

Was this page helpful?