Introduction
- Progress notifications send information about relevant actions that Stacktape performs to a specified destination (e.g. Slack).
- By default, notifications are sent for
deploy
anddelete
commands. - You get notified when:
- the operation successfully starts
- the operation successfully finishes
- an error occurs
Slack notification
For Slack notification, you need to configure 2 things:
accessToken
(Bot User OAuth Token) - You can get it by following first 2 steps in this Slack guide.conversationId
- Can be either channel ID, DM ID, MPDM ID or a group ID. If you simply want to post the notification to a channel, navigate to the channel and click on the channel name. The conversation id is at the bottom of the About tab.
Copy
progressNotifications:- type: slackproperties:conversationId: C#######accessToken: xoxb-####################
No description
Type: string "slack"
Either channel ID, DM ID, MPDM ID or a group ID
Type: string
- If you simply want to post the notification to a channel, navigate to the channel and click on the channel name. The conversation id is at the bottom of the About tab.
Sends notifications only for commands that work with specified stage (e.g. only for production
)
Type: Array of string
Disables update notifications - prints only information about START and FINISH/ERROR of the given operation
Type: boolean
Microsoft Teams notification
For MS Teams notification, you need to configure only one thing:
webhookUrl
- This is the URL that allows Stacktape to send a notification to the channel it's associated with. You can get it by following this guide.
Copy
progressNotifications:- type: ms-teamsproperties:webhookUrl: C#######
No description
Type: string "ms-teams"
URL that allows Stacktape to send a notification to the channel it's associated with
Type: string
- You can get it by following this guide.
Sends notifications only for commands that work with specified stage (e.g. only for production
)
Type: Array of string
Disables update notifications - prints only information about START and FINISH/ERROR of the given operation
Type: boolean