URL Triggers
We've made it easy to trigger modals via URLs so that you can trigger the modals via email campaigns, external links to your site, or to link button to the modals using anchor tags.
Example
https://www.yoursite.com?view=plan-select
List of triggers#
| Description | URL |
|---|---|
| Opens the login modal. | ?view=login |
| Opens the register modal. | ?view=register |
| Opens subscription plan selection modal. | ?view=plan-select |
| Opens the email verification modal and completes verification. | ?view=email-verify&token=123 |
| Opens address create modal. | ?view=address-create |
| Opens the newsletter sign up modal that signs a user up to a newsletter in exchange for their details. | ?view=newsletter |
| Opens the user edit modal. | ?view=user-edit |
| Opens the payment method update modal. | ?view=payment-method-update |
| Opens the password change modal. | ?view=password-change |
| Opens the password reset modal. | ?view=password-reset |
| Opens the gift redemption modal. | ?view=gift-redeem |
| Opens the forgot password modal. | ?view=password-forgot |
| Opens the invoice details modal. | ?view=invoice-details&id=123 |
| Opens the subscription manage members modal. | ?view=manage-members&subscription_id=123 |
| Opens the passwordless request modal. | ?view=passwordless-request |
| Validates the token to complete passwordless login. | ?view=passwordless-login&token=123 |
| Opens the newsletters subscriptions update modal. | ?view=newsletter-update |
| Opens the cart modal after adding the provided comma separated e-commerce SKU IDs. invalid SKU IDs will be ignored. if no valid SKU ID is provided the trigger will be ignored | ?view=cart&sku_id=32,33,34 |
| Starts the checkout flow to purchase the e-commerce item with the provided SKU ID. if the provided SKU ID is invalid the trigger will be ignored | ?view=order-create&sku_id=33 |
plan-select extra parameters#
this trigger allows extra parameters to specify a specific product, plan, and other options as well. You can combine a trigger with multiple parameters in the URL to fulfill your requirements. This is an example of a link that would trigger the select view along with a coupon. https://www.yoursite.com?view=plan-select&coupon_code=12345
| Description | Extra parameter |
|---|---|
| Set the product ID | product_id={product_id} |
| Set the plan ID | plan_id={plan_id} |
| Set the coupon code | coupon_code={COUPON_CODE} |
| Set the gift redemption code | gift_code={GIFT_CODE} |
| Set the gift checkbox, to set the subscription as a gifted one. | is_gift=true |
register extra parameters#
this trigger allows extra parameters to start the subscription flow for a specific offline plan once the user has registered or signed-in. This is an example of a link that would trigger the checkout flow. https://www.yoursite.com?view=register&plan_id=12345
| Description | Extra parameter |
|---|---|
| Set the offline plan ID | plan_id={plan_id} |
newsletter-update extra parameters#
this trigger allows an extra email parameter that lets non-registered or signed-out users subscribe to available newsletters, or update their existing subscriptions. this can be done by passing the email of the user as a value to the email parameter, for example: https://www.yoursite.com?view=newsletter-update&email=test@example.com
If a logged-in user uses the newsletter-update trigger with the email param, and the value of the param doesn't match their account's email, then the trigger will be ignored.
| Description | Extra parameter |
|---|---|
| The email of the user that wants to update their selected newsletters | email={email} |
invoice-details extra parameters#
this trigger allows an extra id parameter that lets signed-in users to review invoice. this can be done by passing the id of the invoice as a value to the id parameter, for example: https://www.yoursite.com?view=invoice-details&id=123
If a logged-in user uses the invoice-details trigger with the id param, and the value of the param doesn't match invoice form invoices, then error will be triggered.
| Description | Extra parameter |
|---|---|
| The id of the invoice that user wants to preview | id={id} |
manage-members extra parameters#
this trigger allows an extra subscription_id parameter that lets signed-in users to manage members of this subscription. this can be done by passing the id of the subscription as a value to the subscription_id parameter, for example: https://www.yoursite.com?view=manage-members&subscription_id=123
If a logged-in user uses the manage-members trigger with the subscription_id param, and the value of the param doesn't match subscription form type membership, then error will be triggered.
| Description | Extra parameter |
|---|---|
| The subscription id that user wants to manage members of | subscription_id={subscription_id} |