Skip to content

Commit

Permalink
Adding Slack doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Menendez6 committed Jul 17, 2024
1 parent 9135f1f commit 9ba4cbe
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 10 deletions.
17 changes: 13 additions & 4 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,19 @@
},
{
"group": "Apps",
"pages": ["quick-start/apps/chargebee"]
"pages": [
"quick-start/apps/chargebee",
"quick-start/apps/slack"
]
}
]
},
{
"group": "Utils",
"pages": ["reference/utils/ping", "reference/utils/uuid"]
"pages": [
"reference/utils/ping",
"reference/utils/uuid"
]
},
{
"group": "Sequences",
Expand Down Expand Up @@ -121,7 +127,10 @@
},
{
"group": "GOBL",
"pages": ["reference/silo/gobl/build", "reference/silo/gobl/sign"]
"pages": [
"reference/silo/gobl/build",
"reference/silo/gobl/sign"
]
}
]
},
Expand Down Expand Up @@ -153,4 +162,4 @@
"linkedin": "https://www.linkedin.com/company/invopop/",
"github": "https://github.com/invopop"
}
}
}
12 changes: 6 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added quick-start/apps/slack-workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions quick-start/apps/slack.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "Slack"
description: Send a message to a Slack channel with the status of a job
---

Invopop's Slack app helps you keep your team updated by sending automated messages to a Slack channel of your choice. With this app, you can set up custom messages to notify your team about job status updates, ensuring everyone stays informed.

## How to use

This guide assumes that you already have a Slack Workspace created.

### 1. Connect to your Slack Workspace

First, you need to connect to your Slack Workspace. To do this, just navigate in the console to the apps section, find the Slack App, click "Connect", then "Configure" and, finally, "Connect with Slack".

This will open a new window showing the scopes required by Invopop. After accepting to connect, if everything worked fine, you will see a message that says "Authorized and connected to:", followed by an icon and name of your Slack Workspace. Now you are all set to use the Slack step in your workflows!

### 2. Add the Slack step in your workflows

To use the Slack step, navigate to the workflows section in the Invopop console and add the Slack step to your workflow. Before being able to use it, you need to select a channel you would like to send it and customize the message.

One use case would be receiving a message when a workflow fails or some step throws a KO. In this case, an example of message you could receive is: "Job fe094ad0-3e12-11ef-bfd5-15fe9005edf3 failed!".

For example, you can configure a message to be sent to the #random channel if a PDF generation fails:

![Example workflow with Slack](quick-start/apps/slack-workflow.png)

Experience seamless updates and instant alerts with our Slack integration.

0 comments on commit 9ba4cbe

Please sign in to comment.