This sub-app guides you on adding your custom function. If you haven't set up the Slack CLI and the project on your local machine yet, visit the top-level guide document first.
- MySendMessage Workflow: Perform
chat.postMessageAPI calls in a custom function
In this example workflow, you will implement your own SendMessage function,
which calls the chat.postMessage API.
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.
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. When creating a trigger, you must select
the workspace that you'd like to create the trigger in. Each workspace has a
development version (denoted by (local)), as well as a deployed version.
To create a link trigger for the workflow in this template, run the following command:
$ slack trigger create --trigger-def ./Custom_Functions/triggers/link.tsAfter selecting a Workspace, the trigger should be created successfully.
After selecting a Workspace, the output provided will include the link trigger 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.
While building your app, you can see your changes propagated to your workspace
in real-time with slack run. In both the CLI and in Slack, you'll know an app
is the development version if the name has the string (local) appended.
# Run app locally
$ slack run
Connected, awaiting eventsOnce running, click the
previously created Shortcut URL associated with the
(local) version of your app. This should start the included sample workflow.
To stop running locally, press <CTRL> + C to end the process.
Once you click the link trigger in a channel, the trigger starts the
Custom_Functions/workflows/my_send_message.ts workflow, which runs your custom
function Custom_Functions/functions/my_send_message.ts.
When it's successful, you will see a "Hello World!" message in the same channel.
For an example of how to test a function, see
Custom_Functions/functions/my_send_message.ts. Test filenames should be
suffixed with _test. You can run the test by running
deno test Custom_Functions/functions/my_send_message_test.ts in your terminal
window.
Once you're done with development, you can deploy the production version of your
app to Slack hosting using slack deploy:
$ slack deployAfter deploying, create a trigger for the production version of your app (not
appended with (local)). Once the trigger is invoked, the workflow should run
just as it did when developing locally.
The app manifest contains the app's configuration. This file defines attributes like app name and description.
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.
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.
A workflow is a set of steps that are executed in order. Each step in a workflow is a function.
Workflows can be configured to run without user input, or they can collect inputs by beginning with a form before continuing to the next step.
Triggers determine when workflows are executed. A trigger file describes a scenario in which a workflow should be run, such as a user pressing a button or when a specific event occurs.
To learn more about other samples, visit the top-level guide to find more!