You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Event filters let you **narrow down the events** sent to your destination by applying simple matching rules. They’re useful when you're only interested in specific types of changes—like ignoring automated updates or focusing on certain attributes.
4
+
5
+
**Filters are optional**: if no filter is defined, your subscription will receive **all events** matching its type and source.
6
+
7
+
Filters are defined when configuring [your subscription](/event-platform/concepts.html) and are automatically evaluated during event routing.
8
+
9
+
> ⚠️ **Note:** For now, only **one filter** can be configured per subscription. Combining multiple filters (e.g., filtering by both user and attribute) is not yet supported.
10
+
11
+
---
12
+
13
+
## `user`*(available)*
14
+
15
+
Use this filter to receive only events triggered by a specific user.
16
+
17
+
-**Syntax**
18
+
`user=user_identifier`
19
+
-**Parameters**
20
+
-`user_identifier`: The UUID of the user who authored the event.
21
+
22
+
-**Example**
23
+
`user=57616f6f-1a4d-490e-bc23-c5877d2b30d9`
24
+
25
+
---
26
+
27
+
## `attribute`*(available soon)*
28
+
29
+
Use this filter to receive only delta events where a specific attribute was updated.
30
+
31
+
-**Syntax**
32
+
`attribute=attribute_code`
33
+
-**Parameters**
34
+
-`attribute_code`: The code of the attribute you want to track.
35
+
36
+
-**Example**
37
+
`attribute=short_description`
38
+
39
+
---
40
+
41
+
## `scope`*(available soon)*
42
+
43
+
Use this filter to receive only delta events related to a specific scope.
44
+
45
+
-**Syntax**
46
+
`scope=scope_code`
47
+
-**Parameters**
48
+
-`scope_code`: The scope code of the updated data.
49
+
50
+
-**Example**
51
+
`scope=my_scope`
52
+
53
+
---
54
+
55
+
## `locale`*(available soon)*
56
+
57
+
Use this filter to receive only delta events for a specific locale.
58
+
59
+
-**Syntax**
60
+
`locale=locale_code`
61
+
-**Parameters**
62
+
-`locale_code`: The locale code of the updated data.
Copy file name to clipboardExpand all lines: content/event-platform/concepts.md
+36-1Lines changed: 36 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -173,6 +173,41 @@ We currently use a static IP address provided by Google Cloud: `34.140.80.128`
173
173
174
174
**However, we cannot guarantee that this IP address will remain unchanged indefinitely.** Therefore, we strongly recommend whitelisting the `europe-west1` IP ranges from [Google Cloud's IP ranges list](https://www.gstatic.com/ipranges/cloud.json) to ensure continuous access.
175
175
176
+
## Subscriptions Filters
177
+
178
+
When configuring a subscription, you can optionally define a **filter** to receive **only the events that match specific criteria**.
179
+
180
+
Here's the available filters you can use:
181
+
- user
182
+
183
+
The following filters will be available soon:
184
+
- attribute
185
+
- scope
186
+
- locale
187
+
188
+
In the future, additional filters and advanced conditions (such as combining multiple filters with `AND` or `OR` operators) will become available.
189
+
190
+
You can find the list of currently available filters and the correct syntax to use [here](/event-platform/available-filters.html).
191
+
192
+
### Example
193
+
Let’s say you want to receive only the events triggered by a specific user, identified by the UUID `ea0fe94f-417e-4078-a40b-38645ba90ebe`.
194
+
You can configure your subscription with the following filter:
Our platform standardises event data across services using the [CloudEvents specification](https://github.com/cloudevents/spec). CloudEvents provides a consistent structure for event data, ensuring interoperability and simplifying event handling. Each event includes essential metadata such as the event type, source, ID, and timestamp.
@@ -220,4 +255,4 @@ Example of an event payload for a productDeleted event
220
255
For more information, consult the [CloudEvents spec attributes](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md).
221
256
222
257
::: panel-link Authorization and authentication requirements [Next](/event-platform/authentication-and-authorization.html)
0 commit comments