1539d1955f
This PR replaces references to _addons_ in the docs with references to _integrations_. In doing so, I have also: - moved `/reference/addons` documents into `/reference/integrations` - combined the previous "Addons" and "Integrations" categories into a new "Integrations" category - added redirects from all the old addons pages to their new locations I have updated the wording, but have not changed things such as API paths, event names, etc, because these will not change at the moment (maybe a breaking change to schedule for v6?). --------- Co-authored-by: Tymoteusz Czech <2625371+Tymek@users.noreply.github.com>
2.5 KiB
| id | title |
|---|---|
| slack | Slack |
This feature was introduced in Unleash v3.11.0.
The Slack integration allows Unleash to post Updates when a feature toggle is updated. To set up Slack, you need to configure an incoming Slack webhook URL. You can follow Sending messages using Incoming Webhooks on how to do that. You can also choose to create a slack app for Unleash, which will provide you with additional functionality to control how Unleash communicates messages on your Slack workspace.
The Slack integration will perform a single retry if the HTTP POST against the Slack Webhook URL fails (either a 50x or network error). Duplicate events may happen. You should never assume events always comes in order.
Configuration
Events
You can choose to trigger updates for the following events:
- feature-created
- feature-updated (*)
- feature-metadata-updated
- feature-project-change
- feature-archived
- feature-revived
- feature-strategy-update
- feature-strategy-add
- feature-strategy-remove
- feature-stale-on
- feature-stale-off
- feature-environment-enabled
- feature-environment-disabled
*) Deprecated, and will not be used after transition to environments in Unleash v4.3
Parameters
Unleash Slack integration takes the following parameters.
- Slack Webhook URL - This is the only required property. If you are using a Slack Application you must also make sure your application is allowed to post to the channel you want to post to.
- Username - Used to override the username used to post the update to a Slack channel.
- Emoji Icon - Used to override the emoji icon used to post the update to a Slack channel.
- Default channel - Where to post the message if the feature toggles has not overridden the channel via the slack tags.
Global configuration
- Unleash URL - The slack plugin uses the
server.unleashUrlproperty to create the link back to Unleash in the posts. This can be set using the UNLEASH_URL environment variable or theserver.unleashUrlproperty when starting the server from node.
Tags
The Slack integration also defined the Tag type "slack". You may use this tag to override which Slack channel Unleash should post updates to for this feature toggle.
In the picture you can see we have defined two slack tags for the "new-payment-system" toggle. In this example Unleash will post updates to the #notifications and #random channel.