Skip to content

Latest commit

 

History

History
260 lines (185 loc) · 8.31 KB

README.md

File metadata and controls

260 lines (185 loc) · 8.31 KB
Raw

Announcement Bot

This sample automation helps users draft, edit, and send announcements to one or more channels.

announcement-bot.mp4

Guide Outline:

Included Workflows

  • Create announcement: Create an announcement draft and later edit or send it to selected channels

Setup

Before getting started, first make sure you have a development workspace where you have permission to install apps. Please note that the features in this project require that the workspace be part of a Slack paid plan.

Install the Slack CLI

To use this sample, you need to install and configure the Slack CLI. Step-by-step instructions can be found in our Quickstart Guide.

Clone the Sample

Start by cloning this repository:

# Clone this project onto your machine
$ slack create my-app -t slack-samples/deno-announcement-bot

# Change into the project directory
$ cd my-app

Running Your Project Locally

While building your app, you can see your changes appear in your workspace in real-time with slack run. You'll know an app is the development version if the name has the string (local) appended.

# Run app locally
$ slack run

Connected, awaiting events

To stop running locally, press <CTRL> + C to end the process.

Creating Triggers

Triggers are what cause workflows to run. These triggers can be invoked by a user, or automatically as a response to an event within Slack.

When you run or deploy your project for the first time, the CLI will prompt you to create a trigger if one is found in the triggers/ directory. For any subsequent triggers added to the application, each must be manually added using the trigger create command.

When creating triggers, you must select the workspace and environment that you'd like to create the trigger in. Each workspace can have a local development version (denoted by (local)), as well as a deployed version. Triggers created in a local environment will only be available to use when running the application locally.

Link Triggers

A link trigger is a type of trigger that generates a Shortcut URL which, when posted in a channel or added as a bookmark, becomes a link. When clicked, the link trigger will run the associated workflow.

Link triggers are unique to each installed version of your app. This means that Shortcut URLs will be different across each workspace, as well as between locally run and deployed apps.

With link triggers, after selecting a workspace and environment, the output provided will include a Shortcut URL. Copy and paste this URL into a channel as a message, or add it as a bookmark in a channel of the workspace you selected. Interacting with this link will run the associated workflow.

Note: triggers won't run the workflow unless the app is either running locally or deployed!

Manual Trigger Creation

To manually create a trigger, use the following command:

$ slack trigger create --trigger-def triggers/create_announcement.ts

Usage

With your app running locally, click the link trigger that you shared in your Slack workspace. The workflow's first step, an input form, will appear where you can completed the required fields.

If you'd like, you can compose an announcement using Block Kit Builder instead of plain text or mrkdwn. Tip: Use the "Copy Payload" button to copy your Block Kit directly to your clipboard.

Here is the format of the blocks that the app expects:

{
  "blocks": [
    {
      "type": "section",
      "text": {
        "type": "mrkdwn",
        "text": "_This_ is an *important* announcement!"
      }
    }
  ]
}

Submitting the form will post the message and other details to the draft channel you provided.

💡 Please note that interactive elements (such as buttons, dropdowns) etc. are not supported.

Use the overflow menu found in the draft message to edit the announcement text. Once ready, click the Send Announcement button to post the announcement in each channel you previously provided in the form.

Once sent, the draft message in channel will be updated and a summary (with links) will be posted to the thread.

Notes

  • Private channels, DM, and MPDMs are not supported in either the destination channels or the draft channel select menus in the OpenForm built-in function.
  • A common reason an announcement might fail to send to a destination channel is that posting has been restricted (restricted_action error). Give your app explicit permission to post using the channel settings if necessary.

Datastores

For storing data related to your app, datastores offer secure storage on Slack infrastructure. For an example of a datastore, see datastores/announcements.ts. The use of a datastore requires the datastore:write/datastore:read scopes to be present in your manifest.

Testing

For an example of how to test a function, see functions/create_draft/handler_test.ts. Test filenames should be suffixed with _test.

Run all tests with deno test:

$ deno test

Deploying Your App

Once development is complete, deploy the app to Slack infrastructure using slack deploy:

$ slack deploy

When deploying for the first time, you'll be prompted to create a new link trigger for the deployed version of your app. When that trigger is invoked, the workflow should run just as it did when developing locally (but without requiring your server to be running).

Viewing Activity Logs

Activity logs of your application can be viewed live and as they occur with the following command:

$ slack activity --tail

Project Structure

.slack/

Contains apps.dev.json and apps.json, which include installation details for development and deployed apps.

datastores/

Datastores securely store data for your application on Slack infrastructure. Required scopes to use datastores include datastore:write and datastore:read.

functions/

Functions are reusable building blocks of automation that accept inputs, perform calculations, and provide outputs. Functions can be used independently or as steps in workflows.

triggers/

Triggers determine when workflows are run. A trigger file describes the scenario in which a workflow should be run, such as a user pressing a button or when a specific event occurs.

workflows/

A workflow is a set of steps (functions) that are executed in order.

Workflows can be configured to run without user input or they can collect input by beginning with a form before continuing to the next step.

manifest.ts

The app manifest contains the app's configuration. This file defines attributes like app name and description.

slack.json

Used by the CLI to interact with the project's SDK dependencies. It contains script hooks that are executed by the CLI and implemented by the SDK.

Resources

To learn more about developing automations on Slack, visit the following: