Skip to content

Commit a7c825f

Browse files
author
markzegarelli
authored
Merge pull request #1835 from segmentio/DOC-266_slack-actions
DOC-266 Slack Actions
2 parents 93cc17c + 159ddeb commit a7c825f

File tree

4 files changed

+97
-3
lines changed

4 files changed

+97
-3
lines changed

‎src/_data/actions/slack.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
actions:
2+
- action: Post Message
3+
blurb: Post Message sends a message to the specified Slack workspace and channel when the associated trigger criteria are met.
4+
fields:
5+
- name: Webhook URL (required)
6+
description: The webhook provided by Slack to connect with the desired workspace.
7+
default:
8+
- name: Message (required)
9+
description: The message that will post to the specified channel. Use a mix of [Slack's formatting](https://api.slack.com/reference/surfaces/formatting){:target="_blank"}, and event variables.
10+
default:
11+
- name: channel
12+
description: The channel within the connected workspace. Do not include the `#` character. For example, use `general`, not `#general`.
13+
default:
14+
- name: User
15+
description: The sender of the posted message.
16+
default: Segment
17+
- name: Icon URL
18+
description: The URL of the image that appears next to the User.
19+
default: https://logo.clearbit.com/segment.com
20+
config:
21+
- category: Connection Settings
22+
settings:
23+
- name: Event Channels
24+
configurable: true
25+
location:
26+
notes: In Slack (Actions), events and channels are set per subscription.
27+
- name: Identify Template
28+
configurable: true
29+
location:
30+
notes: In Slack (Actions), you do not need a specific template for Identifying users. Use the Messages field to write your message, and add data from the event.
31+
- name: Event Template
32+
configurable: true
33+
location:
34+
notes: In Slack (Actions), you do not need a specific template for specific Events. Use the Filter and Messages field to specify the incoming event, and write your message with data from the event.
35+
- name: Incoming Webhook URL
36+
configurable: true
37+
location:
38+
notes: Available as a subscription-level setting on the Post Message action.
39+
- name: Whitelisted Traits
40+
configurable: true
41+
location:
42+
notes: Use the Messages field in the Post Message action to create your message with any traits from an incoming Identify call.
43+

‎src/_includes/components/actions-fields.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ <h3>{{category.category}}</h3>
5050
{% for field in action.fields %}
5151
<tr>
5252
<td>{{field.name}}</td>
53-
<td>{% if field.default %}Default <code>{{field.default}}</code><br />{%endif%}{{field.description}}</td>
53+
<td>{% if field.default %}Default <code>{{field.default}}</code><br />{%endif%}{{field.description | markdownify}}</td>
5454
</tr>
5555
{%endfor%}
5656
</tbody>

‎src/_layouts/default.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,6 @@
6767
<link rel="stylesheet" href="{{ '/assets/algolia.css' | relative_url }}">
6868
</head>
6969
<body>
70-
<!-- This section displays on deploy previews only -->
71-
{% include components/deploy-preview.html %}
7270
<div id="consent-manager"></div>
7371
{{ content }}
7472
<a class="back-scrolling" data-back-scrolling data-active-class="back-scrolling--active">

‎src/connections/destinations/catalog/actions-slack/index.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Slack (Actions) Destination
3+
hide-boilerplate: true
4+
hide-dossier: true
5+
hidden: true
6+
---
7+
{% include content/plan-grid.md name="actions" %}
8+
9+
[Slack](https://www.slack.com){:target="_blank"} is a team collaboration tool work flows. It’s where the people you need, the information you share, and the tools you use come together to get things done.
10+
11+
> info ""
12+
> This document is about a feature which is in beta. This means that the Destination Actions are in active development, and some functionality may change before it becomes generally available
13+
14+
15+
> success ""
16+
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Slack Segment destination. There's also a page about the [non-Actions Slack destination](/docs/connections/destinations/catalog/slack/). Both of these destinations receives data from Segment.
17+
18+
## Benefits of Slack (Actions) vs Slack Classic
19+
20+
Slack (Actions) provides the following benefits over the classic Slack destination:
21+
22+
- **Consolidated Message Sending**. Send multiple messages from a single instance of the Slack (Actions) destinations. Use Event Triggers to send a message when your criteria is met.
23+
- **Streamlined Configuration**. Configure connection details on a per-message basis, rather than for the destination as a whole. This enables sending messages to different workspaces or channels from one source.
24+
- **Easier access to data**. The event variables picker shows you all the available data from the event you use to test the Trigger. Variables are clearly labeled to ensure they stand out from other text and markup.
25+
26+
27+
## Getting Started
28+
29+
1. From the Segment web app, click **Catalog**, then click **Destinations**.
30+
2. Find the Destinations Actions item in the left navigation, and click it.
31+
3. Click **Configure Actions Slack**.
32+
4. Select an existing Source to connect to Slack (Actions).
33+
5. Click Customized Setup to start from a blank mapping.
34+
35+
## Important differences from the classic Slack destination
36+
37+
- The classic Slack destination formats messages using the handlebars syntax. Slack (Actions) follows [Slack's formatting syntax](https://api.slack.com/reference/surfaces/formatting){:target="_blank"}.
38+
39+
## Available Slack actions
40+
41+
Combine the supported [triggers](/docs/connections/destinations/actions/#components-of-a-destination-action) with the following Slack-supported actions:
42+
- [Post Message](#post-message)
43+
44+
{% include components/actions-fields.html name="slack" %}
45+
46+
## Migration from the classic Slack destination
47+
48+
Follow the table below to map your existing Slack destination configuration to Slack (Actions).
49+
50+
> warning ""
51+
> Slack (Actions) uses [Slack's formatting syntax](https://api.slack.com/reference/surfaces/formatting){:target="_blank"}. This requires that you manually re-enter any messages from Slack Classic, and pick event data from the event variable picker. The handlebars syntax from Slack Classic is not compatible.
52+
53+
{% include components/actions-map-table.html name="slack" %}

0 commit comments

Comments
 (0)