User
Web Push Campaigns
Screen guide
Before you start
Use the account and workspace that own the relevant records. The feature also needs to be enabled for this installation and plan.
Open this feature
- Open /portal/web-push/campaigns on your site.
Steps
Choose a task
Use Save A/B test
- Open /portal/web-push/campaigns/ab-test on your application domain, using the workspace account for this task.
- Find the form containing Campaign, Title, Body. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Save A/B test. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Campaign | Required. Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. |
| Title | Complete the visible field for the current selection; follow its validation message. |
| Body | Complete the visible field for the current selection; follow its validation message. |
| Click URL | Complete the visible field for the current selection; follow its validation message. |
| Variant A traffic (%) | Required. Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 10. Maximum 90. |
| Winning metric | Required. Choose Click rate, Conversion rate. |
| Minimum deliveries per variant | Required. Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 20. Maximum 100000. |
Use Use Variant A
- Open /portal/web-push/campaigns/ab-test on your application domain, using the workspace account for this task.
- Find the form containing Campaign, Title, Body. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Use Variant A. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Campaign | Enter the campaign for this task, using the help or example shown by the form. |
| Title | Complete the visible field for the current selection; follow its validation message. |
| Body | Complete the visible field for the current selection; follow its validation message. |
| Click URL | Complete the visible field for the current selection; follow its validation message. |
| Variant A traffic (%) | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 10. Maximum 90. |
| Winning metric | Choose Click rate, Conversion rate. |
| Minimum deliveries per variant | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 20. |
Use Engagement score: :score
- Open /portal/web-push/campaigns/create on your application domain, using the workspace account for this task.
- Find the form containing Site, Campaign name, Audience segment. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Engagement score: :score. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Site | Enter the site for this task, using the help or example shown by the form. |
| Campaign name | Enter the campaign name for this task, using the help or example shown by the form. Internal name used to find this campaign later. |
| Audience segment | Enter the audience segment for this task, using the help or example shown by the form. Leave empty to target all active subscribers on this site. |
| Notification topic | Choose General, Updates, Offers, Alerts. Only subscribers who enabled this topic will receive the campaign. |
| Notification title | Enter the notification title for this task, using the help or example shown by the form. |
| Message | Enter the message for this task, using the help or example shown by the form. Keep the message concise for browser previews. |
| Click URL | Enter the complete address required by this field. For a callback or webhook, copy the URL shown by the running application instead of guessing its path. Where subscribers go when they open the notification. |
| Title | Complete the visible field for the current selection; follow its validation message. |
| Message | Complete the visible field for the current selection; follow its validation message. |
| Delivery | Choose Save as draft, Send now, Schedule. |
| Scheduled time | Enter the scheduled time for this task, using the help or example shown by the form. Required when delivery is scheduled. |
| Repeat schedule | Choose Every day, Every week, Every month. |
| Repeat until (optional) | Enter the repeat until (optional) for this task, using the help or example shown by the form. |
| Scheduled delivery timing | Choose Send at the selected workspace time, Deliver at each subscriber local time. |
| Local hour (0–23) | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Subscribers with a detected timezone are queued when this hour begins locally. Others use the selected workspace time. Minimum 0. Maximum 23. |
Use Send test
- Open /portal/web-push/campaigns/create on your application domain, using the workspace account for this task.
- Find the form containing Site, Test recipient, Notification title. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Send test. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Site | Required. Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. |
| Test recipient | Required. Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. |
| Notification title | Required. Enter the notification title for this task, using the help or example shown by the form. Maximum 120 characters. |
| Message | Required. Enter the message for this task, using the help or example shown by the form. Keep the message concise for browser previews. Maximum 5000 characters. |
| Click URL | Optional unless the current form requests it. Enter the complete address required by this field. For a callback or webhook, copy the URL shown by the running application instead of guessing its path. Where subscribers go when they open the notification. Maximum 2048 characters. |
Use Review current draft
- Open /portal/web-push/campaigns/create on your application domain, using the workspace account for this task.
- Find the form containing Site, Campaign name, Audience segment. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Review current draft. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Site | Enter the site for this task, using the help or example shown by the form. |
| Campaign name | Enter the campaign name for this task, using the help or example shown by the form. Internal name used to find this campaign later. |
| Audience segment | Enter the audience segment for this task, using the help or example shown by the form. Leave empty to target all active subscribers on this site. |
| Notification topic | Choose General, Updates, Offers, Alerts. Only subscribers who enabled this topic will receive the campaign. |
| Tone | Choose Professional, Friendly, Urgent, Playful. |
| Language | Choose Vietnamese, English. |
| Notification title | Enter the notification title for this task, using the help or example shown by the form. |
| Message | Enter the message for this task, using the help or example shown by the form. Keep the message concise for browser previews. |
| Click URL | Enter the complete address required by this field. For a callback or webhook, copy the URL shown by the running application instead of guessing its path. Where subscribers go when they open the notification. |
| Title | Complete the visible field for the current selection; follow its validation message. |
| Message | Complete the visible field for the current selection; follow its validation message. |
| Delivery | Choose Save as draft, Send now, Schedule. |
| Scheduled time | Enter the scheduled time for this task, using the help or example shown by the form. Required when delivery is scheduled. |
| Repeat schedule | Choose Every day, Every week, Every month. |
| Repeat until (optional) | Enter the repeat until (optional) for this task, using the help or example shown by the form. |
| Scheduled delivery timing | Choose Send at the selected workspace time, Deliver at each subscriber local time. |
| Local hour (0–23) | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Subscribers with a detected timezone are queued when this hour begins locally. Others use the selected workspace time. Minimum 0. Maximum 23. |
Use Generate
- Open /portal/web-push/campaigns/create on your application domain, using the workspace account for this task.
- Find the form containing Site, Campaign name, Audience segment. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Generate. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Site | Enter the site for this task, using the help or example shown by the form. |
| Campaign name | Enter the campaign name for this task, using the help or example shown by the form. Internal name used to find this campaign later. |
| Audience segment | Enter the audience segment for this task, using the help or example shown by the form. Leave empty to target all active subscribers on this site. |
| Notification topic | Choose General, Updates, Offers, Alerts. Only subscribers who enabled this topic will receive the campaign. |
| Campaign goal or offer | Required. Enter the campaign goal or offer for this task, using the help or example shown by the form. The form’s example is Example: Announce 20% off annual plans before Friday, including the key benefit and destination.. Replace it with your own value. Maximum 2000 characters. |
| Tone | Choose Professional, Friendly, Urgent, Playful. |
| Language | Choose Vietnamese, English. |
| Notification title | Enter the notification title for this task, using the help or example shown by the form. |
| Message | Enter the message for this task, using the help or example shown by the form. Keep the message concise for browser previews. |
| Click URL | Enter the complete address required by this field. For a callback or webhook, copy the URL shown by the running application instead of guessing its path. Where subscribers go when they open the notification. |
| Title | Complete the visible field for the current selection; follow its validation message. |
| Message | Complete the visible field for the current selection; follow its validation message. |
| Delivery | Choose Save as draft, Send now, Schedule. |
| Scheduled time | Enter the scheduled time for this task, using the help or example shown by the form. Required when delivery is scheduled. |
| Repeat schedule | Choose Every day, Every week, Every month. |
| Repeat until (optional) | Enter the repeat until (optional) for this task, using the help or example shown by the form. |
| Scheduled delivery timing | Choose Send at the selected workspace time, Deliver at each subscriber local time. |
| Local hour (0–23) | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Subscribers with a detected timezone are queued when this hour begins locally. Others use the selected workspace time. Minimum 0. Maximum 23. |
Use Use this draft
- Open /portal/web-push/campaigns/create on your application domain, using the workspace account for this task.
- Find the form containing Site, Campaign name, Audience segment. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Use this draft. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Site | Enter the site for this task, using the help or example shown by the form. |
| Campaign name | Enter the campaign name for this task, using the help or example shown by the form. Internal name used to find this campaign later. |
| Audience segment | Enter the audience segment for this task, using the help or example shown by the form. Leave empty to target all active subscribers on this site. |
| Notification topic | Choose General, Updates, Offers, Alerts. Only subscribers who enabled this topic will receive the campaign. |
| Notification title | Enter the notification title for this task, using the help or example shown by the form. |
| Message | Enter the message for this task, using the help or example shown by the form. Keep the message concise for browser previews. |
| Click URL | Enter the complete address required by this field. For a callback or webhook, copy the URL shown by the running application instead of guessing its path. Where subscribers go when they open the notification. |
| Title | Complete the visible field for the current selection; follow its validation message. |
| Message | Complete the visible field for the current selection; follow its validation message. |
| Delivery | Choose Save as draft, Send now, Schedule. |
| Scheduled time | Enter the scheduled time for this task, using the help or example shown by the form. Required when delivery is scheduled. |
| Repeat schedule | Choose Every day, Every week, Every month. |
| Repeat until (optional) | Enter the repeat until (optional) for this task, using the help or example shown by the form. |
| Scheduled delivery timing | Choose Send at the selected workspace time, Deliver at each subscriber local time. |
| Local hour (0–23) | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Subscribers with a detected timezone are queued when this hour begins locally. Others use the selected workspace time. Minimum 0. Maximum 23. |
Use Add language
- Open /portal/web-push/campaigns/create on your application domain, using the workspace account for this task.
- Find the form containing Site, Campaign name, Audience segment. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Add language. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Site | Enter the site for this task, using the help or example shown by the form. |
| Campaign name | Enter the campaign name for this task, using the help or example shown by the form. Internal name used to find this campaign later. |
| Audience segment | Enter the audience segment for this task, using the help or example shown by the form. Leave empty to target all active subscribers on this site. |
| Notification topic | Choose General, Updates, Offers, Alerts. Only subscribers who enabled this topic will receive the campaign. |
| Notification title | Enter the notification title for this task, using the help or example shown by the form. |
| Message | Enter the message for this task, using the help or example shown by the form. Keep the message concise for browser previews. |
| Click URL | Enter the complete address required by this field. For a callback or webhook, copy the URL shown by the running application instead of guessing its path. Where subscribers go when they open the notification. |
| Title | Complete the visible field for the current selection; follow its validation message. |
| Message | Complete the visible field for the current selection; follow its validation message. |
| Delivery | Choose Save as draft, Send now, Schedule. |
| Scheduled time | Enter the scheduled time for this task, using the help or example shown by the form. Required when delivery is scheduled. |
| Repeat schedule | Choose Every day, Every week, Every month. |
| Repeat until (optional) | Enter the repeat until (optional) for this task, using the help or example shown by the form. |
| Scheduled delivery timing | Choose Send at the selected workspace time, Deliver at each subscriber local time. |
| Local hour (0–23) | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Subscribers with a detected timezone are queued when this hour begins locally. Others use the selected workspace time. Minimum 0. Maximum 23. |
Create or update: Export CSV / Exporting...
- Open /portal/web-push/deliveries on your application domain, using the workspace account for this task.
- Select the intended record or item first and review its displayed values. There is no separate input form described for this control.
- Use the button shown for the current state: Export CSV, Exporting.... Creation and editing can show different labels; submit the form once.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
Use Submit for review
- Open /portal/web-push/campaigns and select the record you want to work with. Its detail/edit address follows /portal/web-push/campaigns/{campaign}. Use the application’s record link; do not type a placeholder such as {id}.
- Find the form containing Review note. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Submit for review. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Review note | Enter the review note for this task, using the help or example shown by the form. |
Use Approve
- Open /portal/web-push/campaigns and select the record you want to work with. Its detail/edit address follows /portal/web-push/campaigns/{campaign}. Use the application’s record link; do not type a placeholder such as {id}.
- Find the form containing Review note. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Approve. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Review note | Enter the review note for this task, using the help or example shown by the form. |
Use Request changes
- Open /portal/web-push/campaigns and select the record you want to work with. Its detail/edit address follows /portal/web-push/campaigns/{campaign}. Use the application’s record link; do not type a placeholder such as {id}.
- Find the form containing Review note. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Request changes. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Review note | Enter the review note for this task, using the help or example shown by the form. |
Fields and choices
Field descriptions appear beside each task above so that separate forms are not mixed together.
Check the result
- Stay in the same account/workspace and reopen the intended record or result screen.
- For saved settings, compare the displayed values with the choices you made. For filters and previews, check the current result scope.
- For queued or external work, inspect its status/history and provider result where applicable. A successful save does not by itself prove message delivery, publication, payment completion or provider approval.
Common problems
| Problem | What to check |
|---|---|
| The screen or action is missing | Check the correct workspace account, role, enabled app and plan. A hidden action is not fixed by typing an internal endpoint. |
| A field is rejected | Read its validation message, choose from the offered options and check the relevant format or limit. Do not substitute a database ID for a displayed choice. |
| A list is empty | Check the selected workspace, search text, date range and status filters. Clear one filter at a time before concluding that records are missing. |
| A request is still pending | Check its status/history before repeating it. For messages, publishing, imports and payments, a submitted request can finish later or fail separately. |
Technical reference
Role-scoped source references
Pinned commit: 68a5655db1bbe17c74fb211f0fe0ee4e63c8be88
Source-only route information
| Method | Source-default route |
|---|---|
| GET | /portal/web-push/campaigns |
| GET | /portal/web-push/analytics/export |
Unmapped fields — not user instructions
These fields belong to this role’s source handler, but their screen labels were not confirmed.
| Source key | Handler |
|---|---|
| form.site_id | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.segment_id | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.topic | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.name | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.title | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.body | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.icon_url | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.image_url | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.click_url | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.send_mode | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.scheduled_at | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.send_time_mode | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.send_time_hour | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.recurrence | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.recurrence_until | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.localizations.*.locale | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.localizations.*.title | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |
| form.localizations.*.body | modules/WebPush/WebPushCampaigns/Livewire/CampaignsIndex.php |