Skip to content

Commit 8cf17b7

Browse files
author
markzegarelli
authored
Merge pull request #1724 from segmentio/DOC-242_dest-action-filters
DOC-242 Destination Actions filters update
2 parents b1ac877 + d609dcc commit 8cf17b7

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

src/connections/destinations/actions.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,24 @@ Each Actions-framework Destination you see in the Segment catalog represents a f
2626
- If you are using Protocols, Destination Actions actions are applied *after* [schema filters](/docs/protocols/enforce/schema-configuration/) and [transformations](/docs/protocols/transform/). If you are using [destination filters](/docs/connections/destinations/destination-filters/), Actions are applied after the filters - meaning that they are not applied to data that is filtered out.
2727
- Destination Actions can not yet be accessed or modified using the Segment APIs.
2828

29+
## Components of a Destination Action
30+
31+
A Destination Action contains a hierarchy of components, that work together to ensure the right data is sent to the destination.
32+
33+
At the top level, is the Destination itself. It has two children: **Global Settings** and **Subscriptions**.
34+
35+
**Global Settings** are where you include authentication information like API keys, and other connection-related information.
36+
37+
**Subscriptions** handle the individual calls to the destination. In them, you define what type of call you want to make to the destination, and what triggers that call. Individual Destination Actions come enabled with some predefined subscriptions to handle common events like Screen calls, Identify calls, and Track calls. Subscriptions have two components that make this possible: **Triggers** and an **Action**.
38+
39+
**Triggers** enable you to define *when* the corresponding Action fires. As part of a Trigger, you can use condition-based filters to narrow the scope of the trigger.
40+
41+
**Actions** determine the information sent to the destination. In the Configure action section, you map the fields that come from your source, to fields that the destination expects to find. Fields on the destination side depend on the type of action selected
42+
43+
For example, in the Amplitude (Actions) destination, you define your API and Secret keys in the destination's global settings. Then, the provided Page Calls subscription:
44+
45+
1. Triggers the action on all incoming Page events.
46+
2. Runs the Log Event action, to map your incoming data to Amplitudes properties.
2947

3048

3149
## Set up a destination action
@@ -87,6 +105,13 @@ The following type filters and operators are available to help you build conditi
87105

88106
You can combine criteria in a single group using **ALL** or **ANY**. Use an ANY to “subscribe” to multiple conditions. Use ALL when you need to filter for very specific conditions. You can only create one group condition per destination action. You cannot created nested conditions.
89107

108+
> info "Destination Filters"
109+
> Destination filters are compatible with Destination Actions. Consider a Destination Filter when:
110+
> - You need to remove properties from the data sent to the destination
111+
> - You need to filter data from multiple types of call (for example, Track, Page, and Identify calls)
112+
>
113+
> If your use case does not match these criteria, you might benefit from using Subscription-level triggers to match only certain events.
114+
90115

91116

92117
<!--

0 commit comments

Comments
 (0)