Skip to content
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

Build workflow updates #740

Merged
merged 8 commits into from
Nov 28, 2024
Merged

Build workflow updates #740

merged 8 commits into from
Nov 28, 2024

Conversation

iampearceman
Copy link
Member

Screen.Recording.2024-11-25.at.1.53.20.mov

After the initial review, I will modify and add the rest.

@scopsy scopsy changed the title I've modified the "Build a Workflow" section - only for the "Platform" tab Build workflow updates Nov 25, 2024
mint.json Outdated
"integrations/providers/push/pushpad",
"integrations/providers/push/push-webhook",
"integrations/providers/push/pusher-beams"
"workflow/channels/sms",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like you changed all the urls for those pages, it will affect SEO. We will need to have redirects to them. But, I don't think the delivery providers should live under workflow, would keep it as parallel concept

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed.

Comment on lines 78 to 80
- Delay
- Digest
- Custom
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add here links and in any other relevant place

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressed.


### Trigger

Every workflow starts with a **trigger**. This is the event that starts a workflow. It represents an action or event that initiates the workflow by making a call to the Novu API, along with a specified workflow trigger identifier (`workflow_id`). The identifier helps match the trigger to the corresponding workflow.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first 2 sentences feel almost identical, maybe rephrase it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed.


Every workflow starts with a **trigger**. This is the event that starts a workflow. It represents an action or event that initiates the workflow by making a call to the Novu API, along with a specified workflow trigger identifier (`workflow_id`). The identifier helps match the trigger to the corresponding workflow.

When a trigger occurs, it sends the necessary payload data that the workflow will use to deliver notifications to subscribers. **Learn more about subscribers**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be a link

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed.

Here's an example of an API call to trigger an event:

```bash
curl -X POST https://api.novu.co/v2/events/trigger \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no v2 events endpoint to my knowledge

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed.

"subscriberId": "<UNIQUE_SUBSCRIBER_IDENTIFIER>",
},
"payload": {}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this one is extra "}"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed.

sidebarTitle: "Step Conditions"
---

**Step Conditions** allow you to customize a **Subscriber's** workflow journey using their **Data**, **Topics**, **Segment Membership**, or prior behavior.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What a segment membership is? we don't have any concept like this

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed.

@scopsy scopsy merged commit 8311003 into v2-dashboard-docs Nov 28, 2024
1 check passed
@scopsy scopsy deleted the emils-branch branch November 28, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants