Outreach Tools

Overview

The Outreach tool category handles all proactive customer engagement: banners, in-app messages, surveys, product tours, and news releases. You can create these items, configure detailed trigger rules for when and where they appear, and publish or unpublish them instantly.

Permission required:Copilot.Outreach

manage_outreach

Creates or updates an outreach item (banner, survey, tour, or message).

Parameters

Parameter	Type	Required	Description
`type`	string	Yes	The outreach type: `"banner"`, `"message"`, `"survey"`, or `"tour"`.
`id`	string	No	Item ID. Omit to create, provide to update.
`name`	string	No	Display name.
`content`	string	No	Body text (for banners and messages).
`published`	boolean	No	Publish status. Defaults to `false` on create.
`widgetId`	string	No	Widget to associate with. Auto-assigns the default widget if omitted.
`config`	object	No	Raw configuration object for advanced settings (banner style, survey flow, tour steps, etc.).

Trigger rules (natural-language):

Parameter	Type	Description
`trigger`	string	When to trigger: `"session_start"`, `"page_view"`, or `"custom_event"`.
`triggerDelay`	number	Delay in seconds after the trigger event.
`customEventName`	string	Custom JavaScript event name (only with `trigger: "custom_event"`).
`pageUrlContains`	string	Only show on pages whose URL contains this string.
`timeOnPageSeconds`	number	Only show after the visitor has spent this many seconds on the page.
`frequency`	string	How often to show: `"once"`, `"every_time"`, or `"limited"`.
`frequencyDays`	number	For limited frequency: within how many days.
`frequencyTimes`	number	For limited frequency: maximum number of times to show.
`countryEquals`	string	Only show to visitors from this country (ISO 2-letter code, e.g., `"US"`).
`countryNotEquals`	string	Hide from visitors in this country.

Parameter	Type	Description
`triggerSettings`	object	Raw trigger config JSON — overrides all natural-language trigger parameters. For advanced use.

How It Works

Creating an outreach item:

Only type is required. A default name is generated (e.g., "New Banner").
The item is associated with your organization's default widget unless you specify widgetId.
Default configurations are applied based on type:
- Banner: inline style, yellow color, no close button.
- Survey: welcome message + thank you message flow.
- Tour: empty steps, no close button.
- Message: empty config.
Items start unpublished by default.

Trigger rules:

You can use natural-language parameters (like trigger, pageUrlContains, countryEquals) and the tool builds the trigger config automatically.
Or you can pass raw triggerSettings JSON for full control.
Natural-language parameters and triggerSettings are mutually exclusive — if both are provided, triggerSettings takes precedence.

Updating an outreach item:

Provide the id and type, plus the fields to change.
When trigger rules are updated, delivery targeting is refreshed automatically.

Example Prompts

"Create a banner announcing our holiday sale."
"Create a survey called 'Customer Feedback' that triggers on page view after 10 seconds."
"Create a product tour for our new dashboard."
"Create a message that shows on the pricing page to US visitors only."
"Set the banner to show only once per visitor."
"Change the trigger to show after 30 seconds on the page."
"Publish my sale banner."
"Update the banner content to say '50% off everything — today only!'"
"Create a survey that only shows on pages containing '/checkout' and triggers after 5 seconds."
"Set the outreach to show a maximum of 3 times within 7 days."
"Target only visitors from Germany."
"Create a message triggered by a custom JavaScript event called 'purchase_complete'."

manage_outreach_news

Creates or updates a news release (news article in the widget's News tab). Supports AI content generation.

Parameters

Parameter	Type	Required	Description
`id`	string	No	News item ID. Omit to create, provide to update.
`title`	string	Conditional	News title. Required when creating.
`content`	string	Conditional	HTML content. Required when creating unless `generateContent` is used.
`generateContent`	string	No	Describe the news article and AI generates HTML. Mutually exclusive with `content`.
`published`	boolean	No	Publish status. Defaults to `false` on create.
`language`	string	No	Content language (e.g., `"en"`, `"hu"`). Defaults to `"en"`.
`widgetId`	string	No	Widget to show this news in. Auto-assigns default widget if omitted.
`imageUrl`	string or null	No	Cover image path (update only). Pass `null` to clear. Images must be uploaded via the dashboard.

How It Works

Creating a news item:

Provide title plus either content (your HTML) or generateContent (a description for AI to write it).
The AI writes well-structured HTML news articles using headings, paragraphs, lists, and other standard elements.
Returns a dashboardUrl where you can review and edit the news item in the visual editor.

Updating a news item:

Provide id and the fields to change.
You can update content using AI by passing generateContent — it generates entirely new content.
To change the cover image, upload it through the dashboard UI first, then reference it here. Pass null to remove the image.

Example Prompts

"Create a news release about our new feature update — generate the content with AI."
"Write a news article titled 'Product Update v2.0' about our new dashboard features."
"Create a news item about our company milestone — we've reached 10,000 customers."
"Publish my product update news release."
"Update the news title to 'Spring 2026 Product Update'."
"Generate a news article about our upcoming webinar series."
"Create a Hungarian language news release about our expansion to the EU market."
"Remove the cover image from my news item."

Common Workflow Patterns

Promotional Campaign

Create a coordinated set of outreach items:

Create a banner → manage_outreach with type "banner"
Create a targeted message → manage_outreach with type "message", page URL filter
Write a news release → manage_outreach_news with generateContent
Publish everything → Update each item with published: true

Example prompt: "Create a complete promotional campaign: a banner for the sale announcement, a targeted message on the pricing page, and a news release about the sale. Generate all content with AI and publish everything."

Feedback Collection

Create a survey → manage_outreach with type "survey", trigger after time on page
Configure targeting → Set page URL filter and frequency
Publish → Update with published: true

Example prompt: "Create a feedback survey that shows after 60 seconds on any page containing '/dashboard', only once per visitor, and only for US visitors."

Product Announcements

Create a news release → manage_outreach_news with generateContent
Create a banner → manage_outreach with type "banner" to drive attention
Publish both → Update with published: true

Example prompt: "Announce our new feature: create a news release with AI-generated content about our new analytics dashboard, and add a banner that shows for 1 week directing visitors to the news."