User
Popup 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/popup/campaigns on your site.
Steps
Choose a task
Create or update: Save changes / Save draft / Save
- Open /portal/popup/campaigns and select the record you want to work with. Its detail/edit address follows /portal/popup/campaigns/create/{type}. Use the application’s record link; do not type a placeholder such as {id}.
- Find the form containing Campaign name, Website, Headline. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Use the button shown for the current state: Save changes, Save draft, Save. 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.
| Field | What to enter or choose |
|---|---|
| Campaign name | Enter the campaign name for this task, using the help or example shown by the form. The form’s example is Summer launch. Replace it with your own value. |
| Website | 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. |
| Headline | Enter the headline for this task, using the help or example shown by the form. The form’s example is A customer just took action. Replace it with your own value. |
| Body | Enter the body for this task, using the help or example shown by the form. The form’s example is Add a short, credible message.. Replace it with your own value. |
| CTA label | Enter the cta label for this task, using the help or example shown by the form. The form’s example is Explore. Replace it with your own value. |
| CTA 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. The form’s example is https://example.com/offer. Replace it with your own value. |
| URL contains | 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. The form’s example is /pricing. Replace it with your own value. |
| UTM campaign | Enter the utm campaign for this task, using the help or example shown by the form. The form’s example is summer-launch. Replace it with your own value. |
| Device | Choose All devices, Desktop, Mobile. |
| Visitor type | Choose All visitors, New visitors, Returning visitors. |
| Referrer contains | Enter the referrer contains for this task, using the help or example shown by the form. The form’s example is google.com. Replace it with your own value. |
| Language | Enter the language for this task, using the help or example shown by the form. The form’s example is en. Replace it with your own value. |
| Delay (seconds) | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. |
| Scroll (%) | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. Maximum 100. |
| Minimum page views | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. |
| Exit intent | Enter the exit intent for this task, using the help or example shown by the form. |
| Position | Choose Bottom left, Bottom right, Top left, Top right, Inline. |
| Animation | Choose Slide, Fade, None. |
| Priority | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 1. |
| Max displays | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 1. |
| Cooldown (hours) | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. |
| One campaign per session | Enter the one campaign per session for this task, using the help or example shown by the form. |
| Background | Choose Solid color, Gradient, Image with overlay. |
| Layout | Choose Card, Compact. |
| Base color | Enter the base color for this task, using the help or example shown by the form. |
| Gradient color | Enter the gradient color for this task, using the help or example shown by the form. |
| Text color | Enter the text color for this task, using the help or example shown by the form. |
| Accent color | Enter the accent color for this task, using the help or example shown by the form. |
| Background image | Enter the background image for this task, using the help or example shown by the form. |
| Image overlay (%) | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. Maximum 90. |
| Hero treatment | Choose None, Community artwork, Product spotlight, Editorial mesh, Soft glow. |
| Hero image | Enter the hero image for this task, using the help or example shown by the form. |
| CTA style | Choose Solid button, Outline button, Text link. |
| Border style | Choose No border, Solid, Dashed. |
| Border width | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. Maximum 8. |
| Border color | Enter the border color for this task, using the help or example shown by the form. |
| Corner radius | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. Maximum 40. |
| Depth | Choose Flat, Soft, Strong. |
| Font size | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 12. Maximum 22. |
| Show close button | Enter the show close button for this task, using the help or example shown by the form. |
| Review quote | Required. Enter the review quote for this task, using the help or example shown by the form. The form’s example is The setup was quick and the result was clear.. Replace it with your own value. Maximum 600 characters. |
| Customer name or attribution | Required. Enter the customer name or attribution for this task, using the help or example shown by the form. The form’s example is Taylor R., Operations. Replace it with your own value. Maximum 120 characters. |
| Rating | Required. Choose 5 / 5, 4 / 5, 3 / 5, 2 / 5, 1 / 5. Minimum 1. Maximum 5. |
| Verified event name | Enter the verified event name for this task, using the help or example shown by the form. The popup only uses matching production events from this workspace. The form’s example is conversion. Replace it with your own value. |
| Collect phone number | Enter the collect phone number for this task, using the help or example shown by the form. |
| Label | Complete the visible field for the current selection; follow its validation message. The form’s example is Company. Replace it with your own value. |
| Field key | Complete the visible field for the current selection; follow its validation message. The form’s example is company. Replace it with your own value. |
| Type | Choose Text, Number, Long text, Date. |
| Placeholder | Complete the visible field for the current selection; follow its validation message. The form’s example is Company (optional). Replace it with your own value. |
| Options | Complete the visible field for the current selection; follow its validation message. For Select, separate options with commas. The form’s example is Small, Medium, Large. Replace it with your own value. |
| Required | Complete the visible field for the current selection; follow its validation message. |
| Inline target selector | Enter the inline target selector for this task, using the help or example shown by the form. The pixel inserts this widget inside the first matching element on the page. The form’s example is [data-popup-slot=notice]. Replace it with your own value. |
| Counter label | Enter the counter label for this task, using the help or example shown by the form. The form’s example is verified conversions. Replace it with your own value. |
| Coupon code | Enter the coupon code for this task, using the help or example shown by the form. The form’s example is WELCOME15. Replace it with your own value. |
| Optional share message | Enter the optional share message for this task, using the help or example shown by the form. Leave empty to use the Popup headline. The page link is always added automatically. The form’s example is Worth sharing with your team. Replace it with your own value. |
| YouTube URL / Audio 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. Use a public YouTube watch or embed URL. / Use a public HTTPS MP3, OGG or WAV URL. The form’s example is https://…. Replace it with your own value. |
| Accept button | Enter the accept button for this task, using the help or example shown by the form. The form’s example is Accept all. Replace it with your own value. |
| Essential-only button | Enter the essential-only button for this task, using the help or example shown by the form. The form’s example is Essential only. Replace it with your own value. |
| Privacy or cookie policy URL (optional) | 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. A Read policy link appears only when you provide a public URL. The form’s example is https://example.com/privacy. Replace it with your own value. |
| Countdown end | Enter the countdown end for this task, using the help or example shown by the form. Choose when the Popup offer ends for visitors. |
| Safe custom markup | Enter the safe custom markup for this task, using the help or example shown by the form. Only basic text, links and list tags are retained. Scripts, styles and event handlers are removed. The form’s example is Important update. Replace it with your own value. |
Use Approve
- Open /portal/popup/campaigns/approvals 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.
- 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.
Use Decline
- Open /portal/popup/campaigns/approvals on your application domain, using the workspace account for this task.
- Find the form containing Reason. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Decline. 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 |
|---|---|
| Reason | Complete the visible field for the current selection; follow its validation message. |
Use Reassign reviewer
- Open /portal/popup/campaigns/approvals on your application domain, using the workspace account for this task.
- Find the form containing Assigned reviewer. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Reassign reviewer. 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 |
|---|---|
| Assigned reviewer | Complete the visible field for the current selection; follow its validation message. |
Use Run preflight Checking...
- Open /portal/popup/campaigns and select the record you want to work with. Its detail/edit address follows /portal/popup/campaigns/{campaign}/preflight. Use the application’s record link; do not type a placeholder such as {id}.
- Select the intended record or item first and review its displayed values. There is no separate input form described for this control.
- Select Run preflight Checking.... 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.
Use Add field
- Open /portal/popup/campaigns and select the record you want to work with. Its detail/edit address follows /portal/popup/campaigns/create/{type}. Use the application’s record link; do not type a placeholder such as {id}.
- Find the form containing Campaign name, Website, Headline. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Add field. 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 name | Enter the campaign name for this task, using the help or example shown by the form. The form’s example is Summer launch. Replace it with your own value. |
| Website | 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. |
| Headline | Enter the headline for this task, using the help or example shown by the form. The form’s example is A customer just took action. Replace it with your own value. |
| Body | Enter the body for this task, using the help or example shown by the form. The form’s example is Add a short, credible message.. Replace it with your own value. |
| CTA label | Enter the cta label for this task, using the help or example shown by the form. The form’s example is Explore. Replace it with your own value. |
| CTA 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. The form’s example is https://example.com/offer. Replace it with your own value. |
| URL contains | 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. The form’s example is /pricing. Replace it with your own value. |
| UTM campaign | Enter the utm campaign for this task, using the help or example shown by the form. The form’s example is summer-launch. Replace it with your own value. |
| Device | Choose All devices, Desktop, Mobile. |
| Visitor type | Choose All visitors, New visitors, Returning visitors. |
| Referrer contains | Enter the referrer contains for this task, using the help or example shown by the form. The form’s example is google.com. Replace it with your own value. |
| Language | Enter the language for this task, using the help or example shown by the form. The form’s example is en. Replace it with your own value. |
| Delay (seconds) | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. |
| Scroll (%) | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. Maximum 100. |
| Minimum page views | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. |
| Exit intent | Enter the exit intent for this task, using the help or example shown by the form. |
| Position | Choose Bottom left, Bottom right, Top left, Top right, Inline. |
| Animation | Choose Slide, Fade, None. |
| Priority | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 1. |
| Max displays | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 1. |
| Cooldown (hours) | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. |
| One campaign per session | Enter the one campaign per session for this task, using the help or example shown by the form. |
| Background | Choose Solid color, Gradient, Image with overlay. |
| Layout | Choose Card, Compact. |
| Base color | Enter the base color for this task, using the help or example shown by the form. |
| Gradient color | Enter the gradient color for this task, using the help or example shown by the form. |
| Text color | Enter the text color for this task, using the help or example shown by the form. |
| Accent color | Enter the accent color for this task, using the help or example shown by the form. |
| Image overlay (%) | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. Maximum 90. |
| Hero treatment | Choose None, Community artwork, Product spotlight, Editorial mesh, Soft glow. |
| CTA style | Choose Solid button, Outline button, Text link. |
| Border style | Choose No border, Solid, Dashed. |
| Border width | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. Maximum 8. |
| Border color | Enter the border color for this task, using the help or example shown by the form. |
| Corner radius | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. Maximum 40. |
| Depth | Choose Flat, Soft, Strong. |
| Font size | Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 12. Maximum 22. |
| Show close button | Enter the show close button for this task, using the help or example shown by the form. |
| Review quote | Enter the review quote for this task, using the help or example shown by the form. The form’s example is The setup was quick and the result was clear.. Replace it with your own value. |
| Customer name or attribution | Enter the customer name or attribution for this task, using the help or example shown by the form. The form’s example is Taylor R., Operations. Replace it with your own value. |
| Rating | Choose 5 / 5, 4 / 5, 3 / 5, 2 / 5, 1 / 5. |
| Verified event name | Enter the verified event name for this task, using the help or example shown by the form. The popup only uses matching production events from this workspace. The form’s example is conversion. Replace it with your own value. |
| Collect phone number | Enter the collect phone number for this task, using the help or example shown by the form. |
| Label | Complete the visible field for the current selection; follow its validation message. The form’s example is Company. Replace it with your own value. |
| Field key | Complete the visible field for the current selection; follow its validation message. The form’s example is company. Replace it with your own value. |
| Type | Choose Text, Number, Long text, Date. |
| Placeholder | Complete the visible field for the current selection; follow its validation message. The form’s example is Company (optional). Replace it with your own value. |
| Options | Complete the visible field for the current selection; follow its validation message. For Select, separate options with commas. The form’s example is Small, Medium, Large. Replace it with your own value. |
| Required | Complete the visible field for the current selection; follow its validation message. |
| Inline target selector | Enter the inline target selector for this task, using the help or example shown by the form. The pixel inserts this widget inside the first matching element on the page. The form’s example is [data-popup-slot=notice]. Replace it with your own value. |
| Counter label | Enter the counter label for this task, using the help or example shown by the form. The form’s example is verified conversions. Replace it with your own value. |
| Coupon code | Enter the coupon code for this task, using the help or example shown by the form. The form’s example is WELCOME15. Replace it with your own value. |
| Optional share message | Enter the optional share message for this task, using the help or example shown by the form. Leave empty to use the Popup headline. The page link is always added automatically. The form’s example is Worth sharing with your team. Replace it with your own value. |
| YouTube URL / Audio 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. Use a public YouTube watch or embed URL. / Use a public HTTPS MP3, OGG or WAV URL. The form’s example is https://…. Replace it with your own value. |
| Accept button | Enter the accept button for this task, using the help or example shown by the form. The form’s example is Accept all. Replace it with your own value. |
| Essential-only button | Enter the essential-only button for this task, using the help or example shown by the form. The form’s example is Essential only. Replace it with your own value. |
| Privacy or cookie policy URL (optional) | 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. A Read policy link appears only when you provide a public URL. The form’s example is https://example.com/privacy. Replace it with your own value. |
| Countdown end | Enter the countdown end for this task, using the help or example shown by the form. Choose when the Popup offer ends for visitors. |
| Safe custom markup | Enter the safe custom markup for this task, using the help or example shown by the form. Only basic text, links and list tags are retained. Scripts, styles and event handlers are removed. The form’s example is Important update. Replace it with your own value. |
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
- modules/Popups/PopupCampaigns/Livewire/PopupApprovalInbox.php
- modules/Popups/PopupCampaigns/Livewire/PopupCampaignAnalytics.php
- modules/Popups/PopupCampaigns/Livewire/PopupCampaignPreflight.php
- modules/Popups/PopupCampaigns/Livewire/PopupCampaignsIndex.php
- modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php
- modules/Popups/PopupCampaigns/Livewire/PopupCampaignTypePicker.php
- modules/Popups/PopupCampaigns/resources/views/livewire/analytics.blade.php
- modules/Popups/PopupCampaigns/resources/views/livewire/approvals.blade.php
- modules/Popups/PopupCampaigns/resources/views/livewire/index.blade.php
- modules/Popups/PopupCampaigns/resources/views/livewire/partials/preview.blade.php
- modules/Popups/PopupCampaigns/resources/views/livewire/preflight.blade.php
- modules/Popups/PopupCampaigns/resources/views/livewire/type-picker.blade.php
- modules/Popups/PopupCampaigns/resources/views/livewire/workspace.blade.php
Source-only route information
| Method | Source-default route |
|---|---|
| GET | /portal/popup/campaigns |
| GET | /portal/popup/campaigns/approvals |
| GET | /portal/popup/campaigns/create |
| GET | /portal/popup/campaigns/create/{type} |
| GET | /portal/popup/campaigns/{campaign}/analytics |
| GET | /portal/popup/campaigns/{campaign}/preflight |
| GET | /portal/popup/campaigns/{campaign}/edit |
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.widget_type | modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php |
| form.headline | modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php |
| form.body | modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php |
| form.countdown_end | modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php |
| form.custom_html | modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php |
| form.social_networks | modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php |
| form.social_networks.* | modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php |
| form.accent_color | modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php |
| form.background_color | modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php |
| form.background_secondary | modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php |
| form.background_image_url | modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php |
| form.hero_image_url | modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php |
| form.text_color | modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php |
| form.border_color | modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php |
| form.font_family | modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php |