Events handled

The following events are handled by the Identity extension:

Identity request identity

Event Description

This event is used for the Identity extension to complete one of the following tasks::

• To retrieve the custom visitor identifiers

• To retrieve the ECID (MID)

• To append the visitor identifiers to an URL

• To synchronize a visitor identifier or a list of identifiers with the ECID service

This event is generated by:

• Calling the Identity getIdentifiers API

• Calling the Identity getExperienceCloudId API

• Calling the Identity appendVisitorInfoForURL (Android) / appendToUrl (iOS) API

• Calling the Identity getUrlVariables API

• Calling the Identity syncIdentifier or syncIdentifiers APIs

Event details

Data payload definition

Here are the key-value pairs in this event:

Event data example

Append to URL request

{
    "baseurl": "https://example.com/path?query=parameter1&other=parameter2"
}

Event data example

Get URL variables request

{
    "urlvariables": true
}

Event data example

Sync identifiers request

{
    "visitoridentifiers": {
        "idtype1" : "id1",
        "idtype2" : "id2"
    },
    "authenticationstate" : 1
}

Generic Identity request Identity

Event Description

This event is used to set identifiers in the Identity extension and it is generated by:

• Calling the MobileCore (Android) / ACPCore (iOS) setAdvertisingIdentifier API

• Calling the MobileCore (Android) / ACPCore (iOS) setPushIdentifier API

Event details

Data payload definition

Here are the key-value pairs in this event:

Event data example

Set the Advertising Identifier request

{
    "advertisingidentifier": "advertisingIdExample"
}

Event data example

Set the Push Identifier request

{
    "pushidentifier": "pushIdExample"
}

Analytics Identity Response

Identity Extension listens to Analytics Identity Response Event to retrieve the value of the Analytics tracking identifier (AID) that is returned as part of the visitor information for the appendToURL and getUrlVariables API calls.

For more details see Analytics response identity Document.

Audience Manager Content Response

The Identity extension listens for the Audience extension response content event for any user opt-out updates. If this response contains optedouthitsent: false an opt-out network call is sent to the Experience Cloud Identity Service.

For more details see Audience Manager Content Response Document.

Configuration Response Content

Event Description

Whenever the configuration extension dispatches the Configuration Response Content event, the Identity extension fetches the URL of the Experience Cloud Identity Service, Experience Cloud Organization Identifier, and the Privacy status settings.

This event is generated in the following scenarios:

• Initial config requested by the customer.

• Configuration modified (remote update or local developer action).

• In response to a configuration request event with the config.getData data key.

For more information about the data payload definition for this event, see the Configuration Keys topics in each extension section.

Event Details

The data property in the Configuration Response Content event is used by each extension to modify its current settings. Each extension is responsible to read out the part of the data property for which it is concerned.

Data Payload Definition

The Identity extension reads the following keys from the configuration event:

Here are the key-value pairs in this event:

Event Hub Shared State

Event Description

The shared state event is dispatched by the event hub after a shared state is created or updated. The event data contains the event owner, the name of the extension to which the shared state belongs. The Identity extension triggers processing the queued events, if any, when the Configuration's shared state is updated.

Event Details

Data Payload Definition

Definition of the key/value pairs that are present in this event

Events dispatched

The following events are dispatched by the Identity extension:

Identity response identity

This event is a response from the Identity extension to the public API callbacks, and it will be generated in response to an Identity Request Identity event when:

• Retrieving the ECID (MID).

• Retrieving the custom visitor identifiers.

• Synchronizing a visitor identifier or a list of identifiers with the ECID Service is complete.

• The result for the append to URL request is ready.

Event details

Data payload definition

Here are the key-value pairs in this event:

Event data example

When all identifiers, blob and location hint are populated

{
    "mid": "midExample",
    "advertisingidentifier": "advertisingIdExample",
    "pushidentifier": "pushIdExample",
    "blob": "blobExample",
    "locationhint": "locationHintExample",
    "visitoridslist": [{
        "id_type": "type1",
        "id_origin": "origin1",
        "id": "id1",
        "authentication_state": 1
    },
    {
        "id_type": "type2",
        "id_origin": "origin2",
        "id": "id2",
        "authentication_state": 2
    }]
}

Event data example

The result for the appendToUrl request:

{
    "updatedurl": "https://example.com/path?query=parameter1&other=parameter2&adobe_mc=TS%3D1563845864296%7CMCMID%3Dmidexample%7CMCORGID%3Dorgidexample%40AdobeOrg%7CMCAID%3Daidexample&adobe_aa_vid=videxample"
}

Event data example

The result for the getUrlVariables request:

{
    "urlvariables": "adobe_mc=TS%3D1563845864296%7CMCMID%3Dmidexample%7CMCORGID%3Dorgidexample%40AdobeOrg%7CMCAID%3Daidexample&adobe_aa_vid=videxample"
}

Configuration content request

The Identity extension dispatches a new Configuration Content Request event when a privacy change is detected in the response that is received from the ECID Service. This event is handled by the Core extension, and the new privacy status is broadcasted to other extensions.

For more details about this event, see the Mobile Core section.

Analytics content request

The Identity extension dispatches a new Analytics Content Request event when a push status preference change is detected, when the push identifier is initially set, or when it is cleared from the SDK. This event is handled by the Analytics extension, and a new internal hit is sent to the Adobe Analytics Server.

For more details about this event see Analytics Content Request​

Shared state

EXTENSION_NAME: com.adobe.module.identity

The Identity extension shared state is created in the following situations:

• When the extension first loads and is initialized.

• When handling a sync request, regardless of whether an actual sync occurs. Occurs when setting the Push Identifier, the Advertising Identifier, or the customer's custom identifiers.

• When the global privacy status changes to optedout, a shared state is set after the identifiers are cleared.