Genesys Cloud Developer Forum

Preview API: Replacement of field "segmentAssignedEvent"

Description

As part of the continuation of AI-202: GPE - Creation of Persistent Level Segmentation (customer-scoped segments), SegmentAssignedEvents will be replaced by SegmentAssignmentEvents in the API endpoint GET /api/v2/journey/sessions/{sessionId}/events. The main driver for this change is to get rid of technical debt in SegmentAssignedEvents that requires a customer ID as the topic partition key. Users of this event on the API will need to update their code.

Fields on the old segmentAssignedEvent field that will no longer exist on the new segmentAssignmentEvent field:

  • segment.displayName

  • segment.version

  • userAgentString

  • browser

  • device

  • geolocation

  • ipAddress

  • ipOrganization

  • mktCampaign

  • dateVisitCreated

  • visitReferrer

event.customerId and event.customerIdType will now always be null on the upper-level event in the payload. These fields are already optional.

There will be new fields on the new segmentAssignmentEvent field that were not on the old segmentAssignedEvent field:

  • assignmentId - The identifier of the persisted segment assignment.

  • assignmentState -Indicates whether the segment has been assigned or unassigned.

Change Category

API

Change Context

The main driver for this change is to get rid of technical debt in SegmentAssignedEvents that requires a customer ID as the topic partition key. This is required to due to the deprecation of customer-service.

Change Impact

Update the event name from segmentAssignedEvent to segmentAssignmentEvent. If referencing any of the fields dropped by the new event, you must remove these fields as they are no longer supported.

Date of Change

Jul 31, 2022

Impacted APIs

GET /api/v2/journey/sessions/{sessionId}/events

References

AI-202, GPE-9908