Skip to content

Commit 4045f51

Browse files
authored
Update paragraph on schema violations
1 parent 6756961 commit 4045f51

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

src/protocols/enforce/schema-configuration.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,10 @@ For example, if you include a single `subscription_id` property in the `Subscrip
4040

4141
**IMPORTANT: Unplanned property omission is ONLY supported in cloud-mode Destinations. Unplanned properties will not be omitted when sending to device-mode Destinations.**
4242

43-
## Track Calls - JSON Schema Violations
44-
Setting this dropdown to Block Event will ensure that all events with JSON schema violations (for example, missing required properties, incorrect property value data types, or invalid regex patterns) will be blocked. A less aggressive option is to select Omit from the dropdown which will simply remove the offending property from the event.
43+
## Block Track Calls - Common JSON Schema Violations
44+
To block all `track` calls that generate a common JSON schema violation, go to your **Schema Configuration**, then go to **Advanced Blocking Controls** and choose **Block Event** from the dropdown. Next, you will need to [edit the underlying JSON schema](https://segment.com/docs/protocols/tracking-plan/create/#edit-underlying-json-schema) and add a rule to the Common JSON Schema definition that you know won't exisit in your `track` event and then trigger a `track` event. Any `track` event that generates a common JSON schema violation will be blocked.
45+
46+
Setting the dropdown to **Block Event** will ensure that all `track` events with JSON schema violations (for example, missing required properties, incorrect property value data types, or invalid regex patterns) will be blocked. A less aggressive option is to select Omit from the dropdown which will simply remove the offending property from the event.
4547

4648
This is an advanced feature that requires extensive testing and a squeaky clean data set + tracking plan to enable. To get a sense of which events will be blocked, or properties omitted, go to the Violations view for a source and note all events with a violation. For example, if you added a `subscription_id` required property to your `Subscription Cancelled` event in your Tracking Plan, the below track call would be blocked by Protocols, or property omitted, depending on your setting.
4749

@@ -60,6 +62,9 @@ Setting this dropdown to Omit Traits will ensure that traits not defined in your
6062

6163
**IMPORTANT: Unplanned identify trait blocking is ONLY supported in cloud-mode Destinations. Events with invalid traits will not be blocked from sending to device-mode Destinations.**
6264

63-
## Identify Calls - Common JSON Schema Violations
64-
To block _unplanned_ `identify` calls, go to your **Schema Configuration**, then go to **Advanced Blocking Controls** and choose Block Events from the dropdown. Next, you will need to [edit the underlying JSON schema](https://segment.com/docs/protocols/tracking-plan/create/#edit-underlying-json-schema) and add a rule to the Common JSON Schema definition that you know won't exisit in your `identify` events and then trigger an `identify` event. Any `identify` event that generates a common JSON schema violation will be blocked.
65+
## Block Identify Calls - Common JSON Schema Violations
66+
To block all `identify` calls that generate a common JSON schema violation, go to your **Schema Configuration**, then go to **Advanced Blocking Controls** and choose **Block Event** from the dropdown. Next, you will need to [edit the underlying JSON schema](https://segment.com/docs/protocols/tracking-plan/create/#edit-underlying-json-schema) and add a rule to the Common JSON Schema definition that you know won't exisit in your `identify` event and then trigger an `identify` event. Any `identify` event that generates a common JSON schema violation will be blocked.
67+
68+
Setting the dropdown to **Block Event** will ensure that all `identify` events with JSON schema violations (for example, missing required traits, incorrect property value data types, or invalid regex patterns) will be blocked. A less aggressive option is to select Omit from the dropdown which will simply remove the offending property from the event.
6569

70+
**IMPORTANT: JSON schema violation event blocking is ONLY supported in cloud-mode Destinations. Events with invalid properties will not be blocked from sending to device-mode Destinations.**

0 commit comments

Comments
 (0)