Skip to main content

Adobe Experience Platform Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to an Adobe Experience Platform location.
aep_api.png

Adobe Experience Platform

  1. Click the + icon on the Nexset that will be sent to the Adobe Experience Platform destination, and select the Send to Destination option from the menu.

  2. Select the Adobe Experience Platform connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Adobe Experience Platform organization, and click Next; or, create a new Adobe Experience Platform credential for use in this flow.

  3. In Nexla, Adobe Experience Platform destinations can be configured using pre-built endpoint templates, which expedite destination setup for common Adobe Experience Platform endpoints.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to write/send data to common Adobe Experience Platform endpoints. Each template is designed specifically for the corresponding Adobe Experience Platform endpoint, making destination setup easy and efficient.

Endpoint Settings​

  • Select the endpoint to which this destination will send data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your destination for this endpoint.

    Create Query (Run SQL)

    Submit a SQL query for execution in AEP Query Service. Nexset must include: dbName (e.g. 'prod:all') and sql. Optional: name, description, insertIntoParameters for CTAS jobs.

      All parameters are optional; omitting filters returns all available records.

      Create Ingestion Batch

      Initialize a new batch ingestion job in AEP Data Ingestion Service. Nexset must include: datasetId and inputFormat.format (parquet or json). Returns a batchId for file upload.

        All parameters are optional; omitting filters returns all available records.

        Create Segment Definition

        Create a new audience segment definition in AEP Segmentation Service. Nexset must include: name, expression.type ('PQL/text'), expression.value (PQL filter), schema.name (XDM class), mergePolicyId.

          All parameters are optional; omitting filters returns all available records.

          Upload File to Batch

          Upload Parquet or JSON file to a batch for ingestion. Core batch data load operation for ETL pipelines.

          • Batch ID (Required): The batch ID to upload the file to (from create_batch endpoint).
          • Dataset ID (Required): The target dataset ID for the file upload.
          • File Name (Required): The name of the file being uploaded (e.g., data.parquet, records.json).

          The Batch ID parameter is required to identify the specific resource to retrieve.

          Complete Batch Ingestion

          Signal batch completion to trigger validation and commit. Finalize batch ingestion workflow after all file uploads.

          • Batch ID (Required): The batch ID to signal completion for.

          The Batch ID parameter is required to identify the specific resource to retrieve.

        Endpoint Testing​

        Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be sent according to the current settings. This allows users to verify that the destination is configured correctly before saving.

        • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

        • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

        Configure Manually​

        Adobe Experience Platform destinations can be manually configured to send data to any valid Adobe Experience Platform API endpoint. Common use cases include ingesting records into datasets via the Batch Ingestion API, upserting Real-Time Customer Profile records, or triggering segment evaluations via the Segmentation API.

        First, select the API method that will be used for calls to the Adobe Experience Platform API from the Method pulldown menu. Common methods for Adobe Experience Platform destination operations include:

        • POST: For creating new records, uploading batch data, or triggering operations
        • PUT: For replacing existing resources in their entirety
        • PATCH: For partial updates to existing resources

        Data Format​

        1. Select the format in which the Nexset data will be sent to the Adobe Experience Platform API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call.

          Adobe Experience Platform APIs typically accept JSON or JSON Lines (newline-delimited JSON) for data ingestion. When using the Batch Ingestion API to upload data to a dataset, the accepted format depends on the dataset schema (Parquet or JSON). For direct API calls such as Profile upserts or segment operations, use application/json.

        API Endpoint URL​

        1. Enter the URL of the Adobe Experience Platform API endpoint to which you want to send the Nexset data in the URL field.

          Common destination endpoint patterns include:

          • Batch Ingestion — Create Batch: https://platform.adobe.io/data/foundation/import/batches
          • Batch Ingestion — Upload File to Batch: https://platform.adobe.io/data/foundation/import/batches/{'{batchId}'}/datasets/{'{datasetId}'}/files/{'{fileName}'}
          • Real-Time Customer Profile — Upsert Entity: https://platform.adobe.io/data/core/ups/models/{'{entityType}'}/{'{entityId}'}
          • Segmentation — Create Segment Definition: https://platform.adobe.io/data/core/ups/segment/definitions

          For update or upsert operations, include the ID of the object to be updated at the end of the URL where required by the specific API endpoint.

          Adobe Experience Platform Batch Ingestion is a two-step process: first create a batch, then upload data files to that batch, and finally signal completion. For high-volume data loads, consider using this pattern with Nexla's webhook response feature to track batch status automatically.

        Request Headers​

        Optional

        • If Nexla should include any additional request headers in API calls to this destination, enter the headers and corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

          Nexla automatically provides the required Adobe Experience Platform headers — Authorization, x-api-key, x-gw-ims-org-id, and x-sandbox-name — from the credential configuration. Additional headers you may need to specify manually include:

          • Content-Type — Specify the format of the request body (e.g., application/json for JSON payloads, application/octet-stream for binary file uploads to the Batch Ingestion API)
          • x-request-id — A custom UUID you can include to trace requests in Adobe's audit logs

          You do not need to include Authorization, x-api-key, x-gw-ims-org-id, or x-sandbox-name in the Request Headers field — these are handled automatically by Nexla using values from your Adobe Experience Platform credential.

        Exclude Attributes from the Call​

        Optional

        • If any record attributes in the Nexset should be omitted when sending data to this Adobe Experience Platform destination, select the attributes from the Exclude Attributes pulldown menu.

        • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

        Record Batching​

        Optional

        1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

        2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

          Adobe Experience Platform's Batch Ingestion API supports large file uploads, but individual API calls to the Profile API or Segmentation API have size limits. For bulk data loads to datasets, consider using the Batch Ingestion workflow. For Profile upserts, keep individual payloads manageable and use batching to group multiple records per API call.

        3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.

        Response Webhook​

        Optional

        Nexla can automatically send the response received from the Adobe Experience Platform API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

        • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

          The Response Webhook feature is particularly useful when using the Adobe Experience Platform Batch Ingestion API. When a batch is created, the API returns a batch ID in the response. Capturing this response as a Nexla webhook source allows you to use that batch ID in subsequent Nexla flows to upload data files or signal batch completion.

        Sample Request Payload​

        Sample request payloads containing a portion of the Nexset data that will be sent to the Adobe Experience Platform API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

        • Click on a sample request payload to expand it and view the complete payload content.
        • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

        Endpoint Testing​

        After all endpoint settings have been configured, Nexla can send a test payload to the Adobe Experience Platform API to ensure that the destination is configured correctly.

        1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

        2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

        3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Adobe Experience Platform API using the current settings.

        Save & Activate the Destination​

        • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to the configured Adobe Experience Platform endpoint, open the destination resource menu and select Activate.

          The Nexset data will not be sent to Adobe Experience Platform until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.