Skip to content

Commit 1f592c1

Browse files
committed
Described enabling the feature
1 parent db9749a commit 1f592c1

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

docs/cdp/cdp_activation/cdp_configuration.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ ibexa:
3232
client_secret: '%env(CDP_ACTIVATION_CLIENT_SECRET)%'
3333
segment_group_identifier: example_segment_group_identifier
3434
membership: # For anonymous user segmentation
35+
enabled: true
3536
activation_id: '%env(CDP_API_ACTIVATION_ID)%'
3637
api_key: '%env(CDP_API_KEY)%'
3738
base_url: 'https://cdp-api.raptorsmartadvisor.com'
@@ -43,6 +44,7 @@ ibexa:
4344
- `activations` - activation details. You can configure multiple activations. They have to be of type `Ibexa` in [[= product_name =]] dashboard
4445
- `client_id` and `client_secret` - client credentials are used to authenticate against the Webhook endpoint. Make sure they're random and secure
4546
- `segment_group_identifier` - a [location](#segment-group) to which CDP data is imported
47+
- `membership.enabled` - enables support for [anonymous users segmenatation](#anonymous-user-segmentation). Set to `true` to activate the feature. Defaults to `false`
4648
- `membership.activation_id` and `membership.api_key` - credentials for the CDP Membership API, required for [anonymous user segmentation](#anonymous-user-segmentation)
4749
- `membership.base_url` - base URL of the CDP Membership API (default: `https://cdp-api.raptorsmartadvisor.com`)
4850
- `membership.timeout` - timeout in seconds for Membership API requests (default: `5`)
@@ -76,7 +78,7 @@ Next, add a segment group identifier to the configuration.
7678

7779
## Anonymous user segmentation
7880

79-
To set up [segmentation for Anonymous visitors](cdp_guide.md#anonymous-user-segmentation), execute the following steps:
81+
To set up [segmentation for anonymous users](cdp_guide.md#anonymous-user-segmentation), execute the following steps:
8082

8183
### Set up CDP API activation
8284

@@ -91,7 +93,7 @@ For more information, see [Website tracking dataflow](https://content.raptorserv
9193

9294
### Configuration
9395

94-
First, add the `membership.activation_id` and `membership.api_key` credentials to your [`ibexa_cdp` configuration](#configuration), using the values for [CDP API activation](#set-up-cdp-api-activation).
96+
Add the `membership.activation_id`, `membership.api_key`, and `membership.enabled: true` to your [`ibexa_cdp` configuration](#configuration), using the credentials for [CDP API activation](#set-up-cdp-api-activation).
9597

9698
To control how long resolved segment memberships are cached per visitor, use the `ibexa_segmentation.anonymous.cache` configuration key:
9799

0 commit comments

Comments
 (0)