Work with Standard integrations external-sources

Navigate to the Configurations section in the left menu and click Manage from the Integrations card.

Then, click Create Integration to start a new configuration.

{modal="regular"}

Optionally, paste a cURL command to auto-fill the URL, HTTP method, headers, and query parameters.

Provide a Name and Description for your integration.

Enter the API endpoint URL.

For path variables, wrap a label in double curly braces in the URL, for example, https://api.example.com/v1/products/{{productId}}, then set each placeholder in Path Parameter.

Select Enable browsing to link an active Browsing integration, so its response fields can be mapped to variables in headers, query and path parameters, and the payload.

➡️ See Create Browsing integrations

{modal="regular"}

Configure the Path Parameter with Name and Default value for every placeholder you added in the URL.

Note that the Name is a marketer-facing label in the editor only, it is not sent on the API request.

{modal="regular"}

Select the HTTP Method between GET and POST.

Click Add Header and/or Add Query Parameters as needed for your integration. For each parameter, provide the following details:

• Parameter: The actual header or query parameter name as expected by the API.

• Name: A marketer-friendly label for this parameter, authors select it when mapping values in campaigns.

• Type: Choose Constant for a fixed value or Variable for dynamic input.

• Value: Enter the value directly for constants, or select a variable mapping.

• Mandatory: Specify whether this parameter is required. For mandatory Variable parameters, if no value is resolved at runtime and no default is provided, request generation fails with an error and the outbound API call is not made.

{modal="regular"}

Choose an Authentication Type:

• No Authentication: For open APIs that do not require any credentials.

• API key: Authenticate requests using a static API key. Enter your API Key Name ​, API Key Value ​ and specify your Location.

• Basic Auth: Use standard HTTP Basic Authentication. Enter Username and Password.

• OAuth 2.0: Authenticate using the OAuth 2.0 protocol. Click the icon to configure or update the Payload.

{modal="regular"}

Set Policy configuration such as Timeout period for API requests and choose to enable throttling, cache and/or retry.

For a POST method, configure the Payload by choosing a Body type:

• JSON: Click the icon and paste your JSON request payload. Map the variables you need to fulfill in the payload.

• GraphQL: Paste your GraphQL query. Journey Optimizer generates an Operation name automatically and lets you map the corresponding query variables.

  {modal="regular"}

Choose the Response type between JSON and HTML.

With the Response payload field, you can decide which fields of the sample output needs to be used for message personalization.

Click the icon and paste a sample JSON response payload to automatically detect data types.

Choose the fields to expose for personalization and specify their corresponding data types.

{modal="regular"}

When the URL, HTTP method, headers, and query parameters are defined, click Send test connection to run a connectivity test and confirm the configuration.

In the Send test connection dialog, enter default values for any Variable placeholders in the URL path, headers, and query parameters.

Those values are included in the test request. Journey Optimizer invokes the endpoint and reports whether the connection succeeded or failed.

{modal="regular"}

If the test returns a successful response, select Use as response payload to copy the response body into the Response payload field, see step 10 under Configure your Integration, where data types can be detected and fields can be selected for personalization.

{modal="regular"}

If the test does not succeed, expand the Error drop-down to review the failure details, update the integration configuration as needed, and run Send test connection again.

{modal="regular"}

Once validated, click Activate.

Access your newly created Integration to:

• Update: Change Authentication details and Policy configuration only. Updates apply to live journeys and campaigns. Before you save changes, use the Explore references menu to confirm where the integration is used.

• Archive: Archive an Integration configuration.

  {modal="regular"}

After activation, click the icon to access the Explore references menu and to review usage for this configuration, including journeys and campaigns that depend on it.

{modal="regular"}