Events Overview¶
Target Audience: Users, Developers, Stakeholders
Introduction¶
This document defines what events can be triggered in the system, which in turn can trigger emails being sent as well as other operations depending on the triggering event and what listeners are available to that event.
Listeners¶
Listed here are some common listeners that could pick up the event.
- Subscription system integration.
- Legacy e-mail. The standard transactional e-mails provided by Payway.
- Third party e-mail. Third party e-mail integrations using the Payway email service.
- Export to external subscription systems such as Kayak, Infosoft, CProfit...etc etc etc.
- Registered webhooks
Events¶
| Name | Description | Webhook | SSI | Legacy e-mail | Third party e-mail |
|---|---|---|---|---|---|
| account_changed | When an account's information is updated | Yes | Yes | No | No |
| account_marketing_permission_changed | When an account's marketing persmission are updated | Yes | Yes | No | No |
| account_archived | When an account is archived | Yes | No | No | No |
| user_product_cancelled | When a userproduct is cancelled | No | No | No | No |
| user_product_uncancelled | When a userproduct is reactivated | No | No | No | No |
| account_activated_for_existing_customer | When an account is activated | Yes | Yes | No | No |
| registered_account_confirmed | When an account is verified | No | No | No | No |
| account_requested_loyalty_card | When a loyalty card link is requested for an account | No | No | No | No |
| account_requested_verification_email | When a verification email is requested for an account | No | No | No | No |
| account_requested_email_change | When a e-mail change is requested for an account | Yes | No | Yes | Yes |
| new_account_registered | When a new account is registered | No | No | No | No |
| confirmation_email_requested | When a confirmation email is requested for an account | Yes | No | Yes | Yes |
| account_requested_password_reset | When a password reset is requested for an account | Yes | No | Yes | Yes |
| account_password_reset_complete | When the password reset procedure is completed for an account | Yes | No | Yes | Yes |
| payment_initiated | When a payment is initiated but not completed | No | No | No | No |
| payment_success | When a payment is completed | No | No | No | No |
| new_subscription_period | When a new subscription period starts. Subscription is renewed | No | No | No | No |
| changed_subscription_renewal_date | When the renewal date for a subscription is changed from PAP | Yes | Yes | No | No |
| payment_profile_update | When a payment profile is updated. Customer updates card details for example | No | No | No | No |
| payment_failure | When a payment fails to be completed | No | No | No | No |
| payment_retry | When a recurring payment fails, indicates that a automatic retry will happen. | No | No | No | |
| payment_retry_successful | When a payment is successfully retried | No | No | No | No |
| verification_failure | When a payment cannot be verified. When a card update fails for example | No | No | No | No |
| offline_payment_paid | When an offline payment is completed | No | No | No | No |
| offline_payment_credited | When an offline payment is credited | No | No | No | No |
| order_closed | When a new order is completed | No | No | No | No |
| gift_created | When a new gift order is created | Yes | No | Yes | Yes |
| gift_order_closed | When a new gift order is completed | No | No | No | No |
| payment_agreement_about_to_expire | When a customer payment agreement is about to expire. Card | No | No | No | No |
| payment_user_agreement_invalid_state | When a customer payment agreement is determined to be invalid | No | No | No | No |
| payment_user_product_deactivated | When a userproduct is deactivated. Subscription is terminated | No | No | No | No |
| payment_user_product_frozen | When a userproduct fails to renew and is frozen | No | No | No | No |
| payment_user_product_renewed | When a userproduct is renewed | No | No | No | No |
| payment_user_product_created | When a userproduct is created. Subscription starts | No | No | No | No |
| payment_campaign_transformed | When a userproduct/subscription is transformed from a campaign into a package | No | No | No | No |
| report_export_requested | When a report is requested from PAP | No | No | No | No |
| package_sharing_initialized | When a user shares his/hers subscription | No | No | No | No |
| package_sharing_activated | When a user accepts a shared subscription | No | No | No | No |
| package_sharing_deactivated | When the sharer deactivates the shared subscription | No | No | No | No |
| package_upgrade | When a subscription is upgraded to a more expensive package | No | No | No | No |
| package_downgrade | When a subscription is downgraded to a less expensive package | No | No | No | No |
| package_downgrade_completed | When a subscription downgrade transforms to the downgraded subscription | No | No | No | No |