logoStacktape docs


Progress NotificationsWork in progress
Work in progress

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 and delete 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: slack
properties:
conversationId: C#######
accessToken: xoxb-####################
SlackNotification  API reference
type
Required

No description

Type: string "slack"

properties.conversationId
Required

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.
properties.accessToken
Required

Bot User OAuth Token

Type: string

stages

Sends notifications only for commands that work with specified stage (e.g. only for production)

Type: Array of string

disableProgressUpdates

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-teams
properties:
webhookUrl: C#######
MsTeamsNotification  API reference
type
Required

No description

Type: string "ms-teams"

properties.webhookUrl
Required

URL that allows Stacktape to send a notification to the channel it's associated with

Type: string

stages

Sends notifications only for commands that work with specified stage (e.g. only for production)

Type: Array of string

disableProgressUpdates

Disables update notifications - prints only information about START and FINISH/ERROR of the given operation

Type: boolean

Need help? Ask a question on SlackDiscord or info@stacktape.com.