diff --git a/mint.json b/mint.json index e70b6c3..4c7a2ab 100644 --- a/mint.json +++ b/mint.json @@ -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", @@ -121,7 +127,10 @@ }, { "group": "GOBL", - "pages": ["reference/silo/gobl/build", "reference/silo/gobl/sign"] + "pages": [ + "reference/silo/gobl/build", + "reference/silo/gobl/sign" + ] } ] }, @@ -153,4 +162,4 @@ "linkedin": "https://www.linkedin.com/company/invopop/", "github": "https://github.com/invopop" } -} +} \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 008e127..5cf6d8c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -506,9 +506,9 @@ "integrity": "sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ==" }, "node_modules/semver": { - "version": "7.6.2", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz", - "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==", + "version": "7.6.3", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", + "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", "bin": { "semver": "bin/semver.js" }, @@ -564,9 +564,9 @@ } }, "node_modules/tslib": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.2.tgz", - "integrity": "sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q==", + "version": "2.6.3", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.3.tgz", + "integrity": "sha512-xNvxJEOUiWPGhUuUdQgAJPKOOJfGnIyKySOc09XkKsgdUV/3E2zvwZYdejjmRgPCgcym1juLH3226yA7sEFJKQ==", "optional": true }, "node_modules/yarn": { diff --git a/quick-start/apps/slack-workflow.png b/quick-start/apps/slack-workflow.png new file mode 100644 index 0000000..18fa948 Binary files /dev/null and b/quick-start/apps/slack-workflow.png differ diff --git a/quick-start/apps/slack.mdx b/quick-start/apps/slack.mdx new file mode 100644 index 0000000..2ed11b8 --- /dev/null +++ b/quick-start/apps/slack.mdx @@ -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.