-
Notifications
You must be signed in to change notification settings - Fork 667
fix: changing messaging to workflows #13215
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 8 commits
99a0980
df31e76
8c734f2
a95a682
0a51df9
6aa2c43
1ef6cd2
43e91ea
0b43e43
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| import CalloutBox from 'components/Docs/CalloutBox' | ||
|
|
||
| <CalloutBox icon="IconInfo" title="Workflows is in beta" type="fyi"> | ||
|
|
||
| Workflows is currently in early beta. While in beta, workflows is free to use. See the overview page for the [proposed pricing model](/docs/workflows#pricing). | ||
|
|
||
| We're always looking for feedback to improve workflows, please [reach out to us directly](https://app.posthog.com/messaging/campaigns#panel=support%3Afeedback%3A%3Alow%3Atrue) in app. | ||
|
|
||
| </CalloutBox> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,14 +4,17 @@ showStepsToc: true | |
| --- | ||
|
|
||
| import Tab from "components/Tab" | ||
| import Beta from './_snippets/beta.mdx' | ||
|
|
||
| <Beta /> | ||
|
|
||
| <Steps> | ||
|
|
||
| <Step title="Create a new messaging channel" badge="required"> | ||
|
|
||
| Before you can design a campaign, you need to configure a messaging channel. Campaigns use messaging channels to deliver messages to your users. | ||
| Before you can design a workflow, you need to configure a messaging channel. Workflows that send messages use messaging channels to deliver messages to your users. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. thats only true for workflows containing email tho, right? |
||
|
|
||
| To create a new channel, go to messaging > [**Channels** tab](https://app.posthog.com/messaging/channels) > click **+ New channel**, and select the channel you want to configure: | ||
| To create a new channel, go to workflows > [**Channels** tab](https://app.posthog.com/messaging/channels) > click **+ New channel**, and select the channel you want to configure: | ||
|
|
||
| <Tab.Group tabs={[ | ||
| 'Email', | ||
|
|
@@ -27,7 +30,7 @@ To create a new channel, go to messaging > [**Channels** tab](https://app.postho | |
|
|
||
| Email is the default messaging channel in PostHog. | ||
|
|
||
| You can use it to send **[drip campaigns](/docs/messaging/email-drip-campaign), transactional messages, or announcements** directly from the Campaign Builder. | ||
| You can use it to send **[drip campaigns](/docs/workflows/email-drip-campaign), transactional messages, or announcements** directly from the Campaign Builder. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. will it still be called campaign builder after havens pr changes? |
||
|
|
||
| ### Configure the channel | ||
|
|
||
|
|
@@ -77,20 +80,20 @@ Navigate to **Messaging** > **Templates** tab > click **+ Create new**. | |
|
|
||
| - Give your template a name. | ||
| - Write your subject line and body content (HTML and text versions are supported). | ||
| - Use variables like `{{ person.name }}` to personalize your message. See the [campaign builder](/docs/messaging/campaign-builder) documentation for more information on available variables. | ||
| - Use variables like `{{ person.name }}` to personalize your message. See the [campaign builder](/docs/workflows/campaign-builder) documentation for more information on available variables. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same here with campaign builder |
||
|
|
||
| Save your template — you'll be able to select it later when you design a campaign. | ||
|
|
||
| You'll still be able to edit the message in the campaign builder. | ||
|
|
||
| </Step> | ||
|
|
||
| <Step title="Use in a campaign" badge="required"> | ||
| <Step title="Use in a workflow" badge="required"> | ||
|
|
||
| Once your channel is created, you can use it in a campaign to deliver messages to your users. | ||
| Once your channel is created, you can use it in a workflow to deliver messages to your users. | ||
|
|
||
| <CallToAction type="primary" to="/docs/messaging/launch-campaign"> | ||
| Launch your first campaign | ||
| <CallToAction type="primary" to="/docs/workflows/launch-workflow"> | ||
| Launch your first workflow | ||
| </CallToAction> | ||
|
|
||
| </Step> | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2,35 +2,38 @@ | |||||
| title: "Set up an email drip campaign" | ||||||
| showStepsToc: true | ||||||
| --- | ||||||
| import Beta from './_snippets/beta.mdx' | ||||||
|
|
||||||
| <Beta /> | ||||||
|
|
||||||
| In this guide we'll walk through creating a simple **drip campaign**. After following this guide, you will: | ||||||
| - Send a welcome email when a user signs up | ||||||
| - Follow up 1 day later if they haven't completed onboarding | ||||||
|
|
||||||
| <Steps> | ||||||
|
|
||||||
| <Step title="Create a campaign" badge="required"> | ||||||
| <Step title="Create a workflow" badge="required"> | ||||||
|
|
||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. style: Text says "Messaging" but should say "Workflows" to match the rebranding
Suggested change
Prompt To Fix With AIThis is a comment left during a code review.
Path: contents/docs/workflows/email-drip-campaign.mdx
Line: 16:16
Comment:
**style:** Text says "Messaging" but should say "Workflows" to match the rebranding
```suggestion
Go to [Workflows](https://app.posthog.com/messaging/campaigns/new/workflow) and click the **+ New campaign button**.
```
How can I resolve this? If you propose a fix, please make it concise.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is a good suggestion, the URL also needs updated once PostHog/posthog#39681 gets merged |
||||||
| Go to [Messaging](https://app.posthog.com/messaging/campaigns/new/workflow) and click the **+ New campaign button**. | ||||||
|
|
||||||
| <ProductScreenshot | ||||||
| imageLight="https://res.cloudinary.com/dmukukwp6/image/upload/w_1600,c_limit,q_auto,f_auto/messaging_new_campaign_light_c1f7b79b46.png" | ||||||
| imageDark="https://res.cloudinary.com/dmukukwp6/image/upload/w_1600,c_limit,q_auto,f_auto/messaging_new_campaign_dark_6a4ea06e58.png" | ||||||
| classes="rounded" | ||||||
| alt="Click the New Campaign button" | ||||||
| alt="Click the New Workflow button" | ||||||
| /> | ||||||
|
|
||||||
| This will open the campaign builder. | ||||||
| This will open the workflow builder. | ||||||
|
|
||||||
| The new campaign only has two blocks: | ||||||
| - A trigger block: This defines the event that will start the campaign workflow. | ||||||
| - An exit block: This defines the event that will end the campaign workflow. | ||||||
| The new workflow only has two blocks: | ||||||
| - A trigger block: This defines the event that will start the workflow. | ||||||
| - An exit block: This defines the event that will end the workflow. | ||||||
|
|
||||||
| <ProductScreenshot | ||||||
| imageLight="https://res.cloudinary.com/dmukukwp6/image/upload/w_1600,c_limit,q_auto,f_auto/new_campaign_light_acfabde4ca.png" | ||||||
| imageDark="https://res.cloudinary.com/dmukukwp6/image/upload/w_1600,c_limit,q_auto,f_auto/new_campaign_dark_8ed34dd06e.png" | ||||||
| classes="rounded" | ||||||
| alt="Fresh campaign with trigger block" | ||||||
| alt="Fresh workflow with trigger block" | ||||||
| /> | ||||||
|
|
||||||
| The trigger block has a little exclamation mark. This means it is not configured. In general, if there are problems with a block, it will have a little exclamation mark. | ||||||
|
|
@@ -39,18 +42,20 @@ The trigger block has a little exclamation mark. This means it is not configured | |||||
|
|
||||||
| <Step title="Set the trigger" badge="required"> | ||||||
|
|
||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. syntax:
Suggested change
Prompt To Fix With AIThis is a comment left during a code review.
Path: contents/docs/workflows/email-drip-campaign.mdx
Line: 44:44
Comment:
**syntax:** `workflow workflow` should be just `workflow`
```suggestion
Now, let's click on the trigger block and configure it. In a new workflow, the trigger doesn't have any default trigger events. Triggers tell PostHog what events will start the workflow.
```
How can I resolve this? If you propose a fix, please make it concise. |
||||||
| Now, let's click on the trigger block and configure it. In a new campaign, the trigger doesn't have any default trigger events. Triggers tell PostHog what events will start the campaign workflow. | ||||||
| Now, let's click on the trigger block and configure it. In a new workflow, the trigger doesn't have any default trigger events. Triggers tell PostHog what events will start the workflow workflow. | ||||||
|
|
||||||
| Change the frequency drop down to `"One time"` this means a user will only go through this workflow once, and cannot be re-enrolled. | ||||||
|
|
||||||
| <ProductScreenshot | ||||||
| imageLight="https://res.cloudinary.com/dmukukwp6/image/upload/w_1600,c_limit,q_auto,f_auto/trigger_settings_light_40e539b7ee.png" | ||||||
| imageDark="https://res.cloudinary.com/dmukukwp6/image/upload/w_1600,c_limit,q_auto,f_auto/trigger_settings_dark_02b15cd094.png" | ||||||
| imageLight="https://res.cloudinary.com/dmukukwp6/image/upload/q_auto,f_auto/frequency_trigger_ff50a0016d.png" | ||||||
| imageDark="https://res.cloudinary.com/dmukukwp6/image/upload/q_auto,f_auto/frequency_trigger_ff50a0016d.png" | ||||||
| classes="rounded" | ||||||
| alt="Trigger warning that event is required" | ||||||
| /> | ||||||
|
|
||||||
| Click the **+ Add trigger event** button and search for the event you want to use as the trigger. | ||||||
|
|
||||||
| Search for your the signup event you capture with PostHog SDKs, (e.g. `user signed up`) and click it. This tells the campaign to start when this event is captured: | ||||||
| Search for your the signup event you capture with PostHog SDKs, (e.g. `user signed up`) and click it. This tells the workflow to start when this event is captured: | ||||||
|
|
||||||
| <ProductScreenshot | ||||||
| imageLight="https://res.cloudinary.com/dmukukwp6/image/upload/c_crop,g_north,h_0.9,w_1.0/w_1600,c_limit,q_auto,f_auto/messaging_new_campaign_event_select_light_a08c890a53.png" | ||||||
|
|
@@ -72,7 +77,7 @@ Don't worry about the conversion goal or exit conditions for now, and exit this | |||||
|
|
||||||
| <Step title="Send the first email" badge="required"> | ||||||
|
|
||||||
| Drag an **Email** dispatch beneath the trigger, into the campaign like this: | ||||||
| Drag an **Email** dispatch beneath the trigger, into the workflow like this: | ||||||
| <ProductScreenshot | ||||||
| imageLight="https://res.cloudinary.com/dmukukwp6/image/upload/w_1600,c_limit,q_auto,f_auto/new_email_light_98795f1414.png" | ||||||
| imageDark="https://res.cloudinary.com/dmukukwp6/image/upload/w_1600,c_limit,q_auto,f_auto/new_email_dark_e2811207c7.png" | ||||||
|
|
@@ -91,7 +96,7 @@ Then, click on the email block to configure it. Set the **subject line** and **s | |||||
|
|
||||||
| > If you haven't configured an email channel yet, you will need to do that first. | ||||||
| > | ||||||
| > <CallToAction className="mb-4" type="primary" to="/docs/messaging/configure-channels"> | ||||||
| > <CallToAction className="mb-4" type="primary" to="/docs/workflows/configure-channels"> | ||||||
| > Configure an email channel | ||||||
| > </CallToAction> | ||||||
| > | ||||||
|
|
@@ -146,32 +151,32 @@ Configure this email with content encouraging them to complete onboarding. Some | |||||
| - Highlight the value they'll get from completing onboarding | ||||||
| - Consider offering help or support | ||||||
|
|
||||||
| The campaign will now: | ||||||
| The workflow will now: | ||||||
| - Exit if their person property `first_onboarding_complete` is set to `true` (they've completed onboarding) | ||||||
| - Send the follow-up email if they have not completed onboarding after the wait period | ||||||
|
|
||||||
| </Step> | ||||||
|
|
||||||
| <Step title="Review and launch" badge="required"> | ||||||
|
|
||||||
| Now the complete campaign should look like this: | ||||||
| Now the complete workflow should look like this: | ||||||
|
|
||||||
| <ProductScreenshot | ||||||
| imageLight="https://res.cloudinary.com/dmukukwp6/image/upload/w_2000,c_limit,q_auto,f_auto/email_drip_overview_light_a84567a8f9.png" | ||||||
| imageDark="https://res.cloudinary.com/dmukukwp6/image/upload/w_2000,c_limit,q_auto,f_auto/email_drip_overview_dark_2bb57406d6.png" | ||||||
| classes="rounded" | ||||||
| alt="Complete campaign workflow" | ||||||
| alt="Complete workflow workflow" | ||||||
|
||||||
| alt="Complete workflow workflow" | |
| alt="Complete workflow" |
Prompt To Fix With AI
This is a comment left during a code review.
Path: contents/docs/workflows/email-drip-campaign.mdx
Line: 168:168
Comment:
**syntax:** `workflow workflow` should be just `workflow`
```suggestion
alt="Complete workflow"
```
How can I resolve this? If you propose a fix, please make it concise.| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,51 +1,54 @@ | ||||||||||
| --- | ||||||||||
| title: "Launch your first messaging campaign" | ||||||||||
| title: "Launch your first workflow" | ||||||||||
| showStepsToc: true | ||||||||||
| --- | ||||||||||
|
|
||||||||||
| import Tab from "components/Tab" | ||||||||||
| import Beta from './_snippets/beta.mdx' | ||||||||||
|
|
||||||||||
| After setting up your [messaging channel](/docs/messaging/configure-channels), you can launch your first campaign. Campaigns are workflows that deliver messages to your users based your configured logic. | ||||||||||
| <Beta /> | ||||||||||
|
|
||||||||||
| This guide covers creating a very basic campaign. See the [campaign builder](/docs/messaging/campaign-builder) for more information on the different components of a campaign, and see the end of this guide for more examples. | ||||||||||
| This guide covers creating a very basic workflow where we send an email to users who perform an event on your app or site. Since we are sending a message (email), you will need to set up a [messaging channel](/docs/workflows/configure-channels) first. | ||||||||||
|
|
||||||||||
| See the [workflow builder](/docs/workflows/workflow-builder) for more information on the different components of a workflow, and see the end of this guide for more examples. | ||||||||||
|
|
||||||||||
| <Steps> | ||||||||||
|
|
||||||||||
| <Step title="Create a campaign" badge="required"> | ||||||||||
| <Step title="Create a workflow" badge="required"> | ||||||||||
|
|
||||||||||
| Go to [Messaging](https://app.posthog.com/messaging/campaigns/new/workflow) and click the **+ New campaign button**. | ||||||||||
| Go to [Workflows](https://app.posthog.com/messaging/campaigns/new/workflow) and click the **+ New campaign button**. | ||||||||||
|
|
||||||||||
| <ProductScreenshot | ||||||||||
| imageLight="https://res.cloudinary.com/dmukukwp6/image/upload/w_1600,c_limit,q_auto,f_auto/messaging_new_campaign_light_c1f7b79b46.png" | ||||||||||
| imageDark="https://res.cloudinary.com/dmukukwp6/image/upload/w_1600,c_limit,q_auto,f_auto/messaging_new_campaign_light_c1f7b79b46.png" | ||||||||||
| classes="rounded" | ||||||||||
| alt="Click the New Campaign button" | ||||||||||
| alt="Click the New Workflow button" | ||||||||||
| /> | ||||||||||
|
|
||||||||||
| This will open the campaign builder: | ||||||||||
| This will open the workflow builder: | ||||||||||
|
|
||||||||||
| <ProductScreenshot | ||||||||||
| imageLight="https://res.cloudinary.com/dmukukwp6/image/upload/w_1600,c_limit,q_auto,f_auto/new_campaign_light_acfabde4ca.png" | ||||||||||
| imageDark="https://res.cloudinary.com/dmukukwp6/image/upload/w_1600,c_limit,q_auto,f_auto/new_campaign_dark_8ed34dd06e.png" | ||||||||||
| classes="rounded" | ||||||||||
| alt="Fresh campaign with trigger block" | ||||||||||
| alt="Fresh workflow with trigger block" | ||||||||||
| /> | ||||||||||
|
|
||||||||||
| The new campaign only has two blocks: | ||||||||||
| - A trigger block: This defines the event that will start the campaign workflow. | ||||||||||
| - An exit block: This defines the event that will end the campaign workflow. | ||||||||||
| The new workflow only has two blocks: | ||||||||||
| - A trigger block: This defines the event that will start the workflow workflow. | ||||||||||
|
||||||||||
| The new workflow only has two blocks: | |
| - A trigger block: This defines the event that will start the workflow workflow. | |
| - A trigger block: This defines the event that will start the workflow. | |
| - An exit block: This defines the event that will end the workflow. |
Prompt To Fix With AI
This is a comment left during a code review.
Path: contents/docs/workflows/launch-workflow.mdx
Line: 37:38
Comment:
**syntax:** `workflow workflow` should be just `workflow`
```suggestion
- A trigger block: This defines the event that will start the workflow.
- An exit block: This defines the event that will end the workflow.
```
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: campaign should be workflow
| On the right side of the workflow builder, you can see the types of blocks available to add to your workflow. |
Prompt To Fix With AI
This is a comment left during a code review.
Path: contents/docs/workflows/launch-workflow.mdx
Line: 40:40
Comment:
**style:** `campaign` should be `workflow`
```suggestion
On the right side of the workflow builder, you can see the types of blocks available to add to your workflow.
```
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
syntax: workflow workflow should be just workflow
| Now, let's click on the trigger block and configure it. In a new workflow, the trigger doesn't have any trigger events. Triggers tell PostHog what events will start the workflow. |
Prompt To Fix With AI
This is a comment left during a code review.
Path: contents/docs/workflows/launch-workflow.mdx
Line: 46:46
Comment:
**syntax:** `workflow workflow` should be just `workflow`
```suggestion
Now, let's click on the trigger block and configure it. In a new workflow, the trigger doesn't have any trigger events. Triggers tell PostHog what events will start the workflow.
```
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
syntax: workflow workflow should be just workflow
| Now that we have a trigger that can initiate the workflow, we need to add an Dispatch to send a message to the users who trigger the workflow. |
Prompt To Fix With AI
This is a comment left during a code review.
Path: contents/docs/workflows/launch-workflow.mdx
Line: 65:65
Comment:
**syntax:** `workflow workflow` should be just `workflow`
```suggestion
Now that we have a trigger that can initiate the workflow, we need to add an Dispatch to send a message to the users who trigger the workflow.
```
How can I resolve this? If you propose a fix, please make it concise.
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
syntax: workflow workflows should be just workflows
| - In the **Logs** tab, you can see logs of recently triggered workflow workflows. Confirm that there aren't any errors. | |
| - In the **Logs** tab, you can see logs of recently triggered workflows. Confirm that there aren't any errors. |
Prompt To Fix With AI
This is a comment left during a code review.
Path: contents/docs/workflows/launch-workflow.mdx
Line: 150:150
Comment:
**syntax:** `workflow workflows` should be just `workflows`
```suggestion
- In the **Logs** tab, you can see logs of recently triggered workflows. Confirm that there aren't any errors.
```
How can I resolve this? If you propose a fix, please make it concise.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: URL still references old
/messaging/campaignspath instead of new/workflowspathPrompt To Fix With AI
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This suggestion will be necessary as soon as PostHog/posthog#39681 merges