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
The following events are handled by the Edge extension client-side.
Edge request content
This event is a request to process and deliver an Experience event to Edge Network. This event is captured by the Edge Network extension's event listener in the Event Hub for processing and sent to Edge Network.
If the required xdm key is not present in the event data payload, the event is not sent to Edge Network. To learn more about Experience Data Model (XDM), please read the XDM system overview.
XDM formatted data; use an XDMSchema implementation for better XDM data ingestion and data format control.
data
Map<String, Object>
No
Optional free-form data associated with this event.
config
Map<String, Object>
No
Optional config settings. Find the available keys for config below.
datasetId
String
No
Optional custom dataset ID. If not set, the event uses the default Experience dataset ID set in the datastream configuration.
request
Map<String, Object>
No
Optional request parameters. Find the available keys for request below.
config
Key
Value type
Required
Description
datastreamIdOverride
String
No
Optional datastream identifier used to override the default datastream identifier set in the Edge configuration.
datastreamConfigOverride
Map<String, Object>
No
Optional datastream configuration used to override individual settings from the default datastream configuration.
request
Key
Value type
Required
Description
path
String
No
Optional path to be used for the Edge request.
sendCompletion
Boolean
No
Optional flag to determine if a "complete" event is requested.
Note
Events of this type and source are only processed if the data collection consent status stored in the collect property is notn (no); that is, either y (yes) or p (pending).
Edge request identity
This event is a request to get the current location hint being used by the Edge Network extension in requests to the Edge Network. The Edge Network location hint may be used when building the URL for Edge Network requests to hint at the server cluster to use.
XDM formatted consent preferences. See the Consent.update(consents) API reference for how to properly format this property.
Edge update identity
This event is a request to set the Edge Network location hint used by the Edge Network extension in requests to Edge Network.
Warning
Use caution when setting the location hint. Only use valid location hints defined within the EdgeNetwork scope. An invalid location hint value will cause all Edge Network requests to fail with a 404 response code.
This event contains the latest consent preferences synced with the SDK. The Edge Network extension reads the current data collection consent settings stored in the collect property and adjusts its internal queueing behavior based on the value as follows:
Value
Description
Behavior
y
Yes
Hits are sent
n
No
Hits are dropped and not sent
p
Pending
Hits are queued until y/n is set; when set, queued events follow the value's behavior
When this event is received, the Edge extension queues it up and removes the cached internal state:store settings. If other events are queued before this event, those events will be processed first in the order they were received.
The following events are dispatched by the Edge extension client-side.
Edge identity response
This event is a response to the Edge request identity event with data payload containing locationHint = true and provides the location hint being used by the Edge Network extension in requests to the Edge Network. The Edge Network location hint may be used when building the URL for Edge Network requests to hint at the server cluster to use.
Event details
Event type
Event source
com.adobe.eventType.edge
com.adobe.eventSource.responseIdentity
Event data payload definition
Key
Value type
Required
Description
locationHint
String
Yes
The Edge Network location hint currently set for use when connecting to Edge Network.
Edge error response content
This event is an error response to an originating event. If there are multiple error responses for a given triggering event, separate error event instances will be dispatched for each error.
Event details
Event type
Event source
com.adobe.eventType.edge
com.adobe.eventSource.errorResponseContent
Event data payload definition
Key
Value type
Required
Description
requestId
String
Yes
The ID (UUID) of the batched Edge Network request tied to the event that triggered the error response.
requestEventId
String
Yes
The ID (UUID) of the event that triggered the error response.
Edge response content
This event is a response to an Edge request content event. This event is constructed using the response fragment from the Edge Network service for a sent XDM Experience Event; Edge Network extension does not modify any values received and constructs a response event with the event source and data payload as-is. This event is only dispatched if the response fragment doesn't define a type, otherwise an event using the response type is dispatched such as a state:store or locationHint:result.
Event details
Event type
Event source
com.adobe.eventType.edge
com.adobe.eventSource.responseContent
Event data payload definition
This event does not have standard keys.
Edge state store
This event tells the Edge Network extension to persist the event payload to the data store. This event is constructed using the response fragment from the Edge Network service for a sent XDM Experience Event; Edge Network extension does not modify any values received and constructs a response event with the event source and data payload as-is.
Event details
Event type
Event source
com.adobe.eventType.edge
state:store
Event data payload definition
This event does not have standard keys.
Edge location hint result
This event tells the Edge Network extension to persist the location hint to the data store. This event is constructed using the response fragment from the Edge Network service for a sent XDM Experience Event; Edge Network extension does not modify any values received and constructs a response event with the event source and data payload as-is.
Event details
Event type
Event source
com.adobe.eventType.edge
locationHint:result
Event data payload definition
Key
Value type
Required
Description
scope
String
No
The scope that the location hint applies to, for example EdgeNetwork.
hint
String
No
The location hint string.
ttlSeconds
int
No
The time period the location hint should be valid for.
Edge content complete
This event is a response to an Edge request content event and is sent when the Edge Network request is complete. This event is only dispatched when requested by the request content event when the request payload object contains the property sendCompletion with boolean value true.
Event details
Event type
Event source
com.adobe.eventType.edge
com.adobe.eventSource.contentComplete
Event data payload definition
Key
Value type
Required
Description
requestId
String
Yes
The ID (UUID) of the batched Edge Network request tied to the event that requested the completion response.