Skip to main content

Kargo 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 a Kargo location.
kargo.png

Kargo

Create a Kargo Destination​

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

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

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

    Kargo destinations can also be configured manually, allowing you to send data to Kargo 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 Kargo endpoints. Each template is designed specifically for the corresponding Kargo 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.

    Submit Report

    Submit a report. Check out the documentation URL for more details on record schema.

    • This endpoint automatically submits reports to the Kargo Data Sharing API using data from your Nexset. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses POST requests to https://datasharingapi.prod.kargo.com/v1/reports to submit reports. The endpoint URL is automatically constructed based on the Kargo Data Sharing API base URL.
    • The endpoint sends data from your Nexset as the request body in JSON format. The request body is automatically formatted according to the schema fields and data mapping you configure. Each record in your Nexset will be sent as a JSON object containing the report data to submit.
    • Batch mode is disabled by default for this endpoint, which means each record from your Nexset will be sent as a separate API request. This ensures that each report is submitted individually.
    • This endpoint does not automatically create a data source to track the responses received from the Kargo Data Sharing API after each call.

    The request body must be properly formatted JSON that matches the Kargo Data Sharing API specification for submitting reports. The endpoint requires authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. The request body must conform to the record schema defined in the Kargo Data Sharing API documentation. For detailed information about submitting reports, including required fields, record schema, and request formats, see the Kargo Data Sharing API documentation.

Configure Manually​

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

With manual configuration, you can also create more complex Kargo destinations, such as destinations that use custom request headers, different HTTP methods, or custom data formatting.

Content Format​

  1. Select the format in which the Nexset data will be sent to the Kargo Data Sharing API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Kargo Data Sharing API typically uses JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the Kargo Data Sharing API endpoint to which you want to send the Nexset data in the URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Kargo Data Sharing API endpoints typically follow the pattern https://datasharingapi.prod.kargo.com/v1/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. The access token is obtained through the authentication endpoint using your username and password. For detailed information about Kargo Data Sharing API endpoints, authentication, and available APIs, see the Kargo Data Sharing API documentation.