Skip to content
Appwarden Documentation

Slack Commands

Overview

Section titled “Overview”

Appwarden provides a set of Slack slash commands to help you manage your domains, incidents, and channel settings. Each command is prefixed with appwarden so it is available as a top-level slash command in your Slack workspace.

The following commands are issued from a Slack channel where Appwarden has been installed. If you haven’t already, add Appwarden to your Slack workspace from Settings > Integrations > Slack in the Appwarden dashboard and follow the getting started guide.

Setup

Section titled “Setup”

Before you can use slash commands, you must connect a Slack channel to your Appwarden organization.

Run in the Slack channel you want to connect
/appwarden-setup your-setup-code

The /appwarden-setup command sets the current channel as the default Appwarden channel for your organization. Replace your-setup-code with the setup code found in your Appwarden dashboard.

You can find your Slack setup code in the Appwarden dashboard at Settings > Integrations > Slack.

Commands

Section titled “Commands”

/appwarden-quarantine

Section titled “/appwarden-quarantine”

The /appwarden-quarantine commands are used to manage the quarantine status of a domain. When a domain is quarantined and a visitor lands on any route, a lock page is displayed in place of the normal content. Quarantining a domain is useful when you suspect a security breach or otherwise want to prevent access to your domain.

lock

Section titled “lock”
Run in your Slack channel
/appwarden-quarantine lock

The /appwarden-quarantine lock command is used to place a domain under quarantine. When a domain is quarantined, a lock page is displayed in place of the normal content.

In a few seconds, your domain will be quarantined and visitors will see the lock page on every route. Changes to the quarantine state may take up to 30 seconds to propagate.

In order to quarantine a domain, the domain must be verified. You can view the verification status of your domains by navigating to Settings > Security in the Appwarden dashboard.

unlock

Section titled “unlock”
Run in your Slack channel
/appwarden-quarantine unlock

The /appwarden-quarantine unlock command is used to remove a domain from quarantine. When a domain is unlocked, normal website content is displayed to visitors.

/appwarden-incident

Section titled “/appwarden-incident”
Run in your Slack channel
/appwarden-incident <description>

The /appwarden-incident command is used to declare an incident on your domain. Declared incidents are typically used to communicate planned changes, maintenance windows, or other situations that Appwarden is unable to detect.

You can declare an incident by providing the description inline, or by running /appwarden-incident without any text to open a modal with a description input.

When an incident is declared, Appwarden posts an incident message to your default Slack channel to notify your team, and optionally pages your team members via PagerDuty. You may only have one active declared incident at a time.

/appwarden-help

Section titled “/appwarden-help”
Run in your Slack channel
/appwarden-help

The /appwarden-help command is used to view a list of Appwarden Slack commands and other helpful information.