Skip to main content

Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to an Optimizely location.
optimizely_api.png

Optimizely

Create an Optimizely Destination​

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

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

  3. In Nexla, Optimizely destinations can be created using pre-built endpoint templates, which expedite destination setup for common Optimizely endpoints. Each template is designed specifically for the corresponding Optimizely endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Optimizely destinations can also be configured manually, allowing you to send data to Optimizely endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

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

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create Custom Event

    This endpoint template creates a custom event in an Optimizely project using records from a Nexset. Use this template when you need to create custom events in Optimizely for tracking user interactions, conversions, or other custom metrics. Click on the API documentation link to see the recommended payload structure.

    • Enter the Optimizely Project ID in the Optimizely Project ID field. This should be the unique identifier of the Optimizely project in which you want to create custom events. The Project ID determines which project will receive the custom events. You can find the Project ID in your Optimizely account or by using the "Get all Projects" endpoint.

    This endpoint sends data as JSON in the request body to create a custom event in an Optimizely project. Each record from your Nexset will be sent as a separate API request to create a new custom event in Optimizely. The request body should contain the event data in the format required by the Optimizely API for custom events.

    The event structure must match the Optimizely API's expected format for custom events. For detailed information about custom event creation, request body formats, available event properties, and recommended payload structures, see the Optimizely API documentation.

Configure Manually​

Optimizely destinations can be manually configured to send data to any valid Optimizely API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Optimizely API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Optimizely API from the Method pulldown menu. Optimizely API typically uses POST method for creating resources.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Optimizely API from the Content Format pulldown menu. Optimizely API expects JSON format for all requests.

API Endpoint URL​

  1. Enter the URL of the Optimizely API endpoint to which data will be sent in the URL field. This should be the complete URL to your Optimizely endpoint (e.g., https://api.optimizely.com/v2/projects/{project_id}/custom_events). Include any required path parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Optimizely API endpoint URL should point to the endpoint where you want to create resources. You can test the endpoint using the Test button after configuring the URL.

Request Body​

  1. Configure the request body that will be sent to the Optimizely API. The request body should contain the resource data formatted as JSON, with field names matching the Optimizely API's expected structure. The request body format is typically {message.json} to send the entire Nexset data as JSON, or you can construct a custom JSON structure with specific field mappings.

The request body must be valid JSON and must match the Optimizely API's expected format for the specific endpoint you're using. Optimizely API uses specific structures for different endpoints (custom events, etc.). For detailed information about request body formats, available endpoints, and resource structures, see the Optimizely API documentation.

Save the Destination​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the destination configuration for later use.