All guides
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
  1. Open /portal/popup/campaigns on your site.

Steps

Create or update: Save changes / Save draft / Save

  1. 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}.
  2. 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.
  3. Use the button shown for the current state: Save changes, Save draft, Save. Creation and editing can show different labels; submit the form once.
  4. 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.
FieldWhat to enter or choose
Campaign nameEnter 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.
WebsiteEnter 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.
HeadlineEnter 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.
BodyEnter 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 labelEnter 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 URLEnter 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 containsEnter 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 campaignEnter 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.
DeviceChoose All devices, Desktop, Mobile.
Visitor typeChoose All visitors, New visitors, Returning visitors.
Referrer containsEnter 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.
LanguageEnter 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 viewsEnter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0.
Exit intentEnter the exit intent for this task, using the help or example shown by the form.
PositionChoose Bottom left, Bottom right, Top left, Top right, Inline.
AnimationChoose Slide, Fade, None.
PriorityEnter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 1.
Max displaysEnter 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 sessionEnter the one campaign per session for this task, using the help or example shown by the form.
BackgroundChoose Solid color, Gradient, Image with overlay.
LayoutChoose Card, Compact.
Base colorEnter the base color for this task, using the help or example shown by the form.
Gradient colorEnter the gradient color for this task, using the help or example shown by the form.
Text colorEnter the text color for this task, using the help or example shown by the form.
Accent colorEnter the accent color for this task, using the help or example shown by the form.
Background imageEnter 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 treatmentChoose None, Community artwork, Product spotlight, Editorial mesh, Soft glow.
Hero imageEnter the hero image for this task, using the help or example shown by the form.
CTA styleChoose Solid button, Outline button, Text link.
Border styleChoose No border, Solid, Dashed.
Border widthEnter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. Maximum 8.
Border colorEnter the border color for this task, using the help or example shown by the form.
Corner radiusEnter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. Maximum 40.
DepthChoose Flat, Soft, Strong.
Font sizeEnter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 12. Maximum 22.
Show close buttonEnter the show close button for this task, using the help or example shown by the form.
Review quoteRequired. 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 attributionRequired. 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.
RatingRequired. Choose 5 / 5, 4 / 5, 3 / 5, 2 / 5, 1 / 5. Minimum 1. Maximum 5.
Verified event nameEnter 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 numberEnter the collect phone number for this task, using the help or example shown by the form.
LabelComplete the visible field for the current selection; follow its validation message. The form’s example is Company. Replace it with your own value.
Field keyComplete the visible field for the current selection; follow its validation message. The form’s example is company. Replace it with your own value.
TypeChoose Text, Number, Long text, Date.
PlaceholderComplete the visible field for the current selection; follow its validation message. The form’s example is Company (optional). Replace it with your own value.
OptionsComplete 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.
RequiredComplete the visible field for the current selection; follow its validation message.
Inline target selectorEnter 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 labelEnter 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 codeEnter 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 messageEnter 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 URLEnter 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 buttonEnter 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 buttonEnter 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 endEnter 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 markupEnter 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

  1. Open /portal/popup/campaigns/approvals on your application domain, using the workspace account for this task.
  2. Select the intended record or item first and review its displayed values. There is no separate input form described for this control.
  3. Select Approve. Check the current record, recipients, amount or destination before confirming when those values apply.
  4. 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

  1. Open /portal/popup/campaigns/approvals on your application domain, using the workspace account for this task.
  2. Find the form containing Reason. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
  3. Select Decline. Check the current record, recipients, amount or destination before confirming when those values apply.
  4. 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.
FieldWhat to enter or choose
ReasonComplete the visible field for the current selection; follow its validation message.

Use Reassign reviewer

  1. Open /portal/popup/campaigns/approvals on your application domain, using the workspace account for this task.
  2. Find the form containing Assigned reviewer. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
  3. Select Reassign reviewer. Check the current record, recipients, amount or destination before confirming when those values apply.
  4. 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.
FieldWhat to enter or choose
Assigned reviewerComplete the visible field for the current selection; follow its validation message.

Use Run preflight Checking...

  1. 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}.
  2. Select the intended record or item first and review its displayed values. There is no separate input form described for this control.
  3. Select Run preflight Checking.... Check the current record, recipients, amount or destination before confirming when those values apply.
  4. 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

  1. 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}.
  2. 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.
  3. Select Add field. Check the current record, recipients, amount or destination before confirming when those values apply.
  4. 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.
FieldWhat to enter or choose
Campaign nameEnter 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.
WebsiteEnter 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.
HeadlineEnter 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.
BodyEnter 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 labelEnter 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 URLEnter 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 containsEnter 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 campaignEnter 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.
DeviceChoose All devices, Desktop, Mobile.
Visitor typeChoose All visitors, New visitors, Returning visitors.
Referrer containsEnter 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.
LanguageEnter 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 viewsEnter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0.
Exit intentEnter the exit intent for this task, using the help or example shown by the form.
PositionChoose Bottom left, Bottom right, Top left, Top right, Inline.
AnimationChoose Slide, Fade, None.
PriorityEnter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 1.
Max displaysEnter 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 sessionEnter the one campaign per session for this task, using the help or example shown by the form.
BackgroundChoose Solid color, Gradient, Image with overlay.
LayoutChoose Card, Compact.
Base colorEnter the base color for this task, using the help or example shown by the form.
Gradient colorEnter the gradient color for this task, using the help or example shown by the form.
Text colorEnter the text color for this task, using the help or example shown by the form.
Accent colorEnter 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 treatmentChoose None, Community artwork, Product spotlight, Editorial mesh, Soft glow.
CTA styleChoose Solid button, Outline button, Text link.
Border styleChoose No border, Solid, Dashed.
Border widthEnter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. Maximum 8.
Border colorEnter the border color for this task, using the help or example shown by the form.
Corner radiusEnter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0. Maximum 40.
DepthChoose Flat, Soft, Strong.
Font sizeEnter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 12. Maximum 22.
Show close buttonEnter the show close button for this task, using the help or example shown by the form.
Review quoteEnter 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 attributionEnter 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.
RatingChoose 5 / 5, 4 / 5, 3 / 5, 2 / 5, 1 / 5.
Verified event nameEnter 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 numberEnter the collect phone number for this task, using the help or example shown by the form.
LabelComplete the visible field for the current selection; follow its validation message. The form’s example is Company. Replace it with your own value.
Field keyComplete the visible field for the current selection; follow its validation message. The form’s example is company. Replace it with your own value.
TypeChoose Text, Number, Long text, Date.
PlaceholderComplete the visible field for the current selection; follow its validation message. The form’s example is Company (optional). Replace it with your own value.
OptionsComplete 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.
RequiredComplete the visible field for the current selection; follow its validation message.
Inline target selectorEnter 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 labelEnter 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 codeEnter 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 messageEnter 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 URLEnter 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 buttonEnter 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 buttonEnter 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 endEnter 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 markupEnter 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

  1. Stay in the same account/workspace and reopen the intended record or result screen.
  2. For saved settings, compare the displayed values with the choices you made. For filters and previews, check the current result scope.
  3. 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

ProblemWhat to check
The screen or action is missingCheck the correct workspace account, role, enabled app and plan. A hidden action is not fixed by typing an internal endpoint.
A field is rejectedRead 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 emptyCheck 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 pendingCheck 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
MethodSource-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 keyHandler
form.widget_typemodules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php
form.headlinemodules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php
form.bodymodules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php
form.countdown_endmodules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php
form.custom_htmlmodules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php
form.social_networksmodules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php
form.social_networks.*modules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php
form.accent_colormodules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php
form.background_colormodules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php
form.background_secondarymodules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php
form.background_image_urlmodules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php
form.hero_image_urlmodules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php
form.text_colormodules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php
form.border_colormodules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php
form.font_familymodules/Popups/PopupCampaigns/Livewire/PopupCampaignsWorkspace.php