Convey

Convey is a delivery experience platform that provides real-time shipping visibility, proactive communication, and delivery optimization tools, helping e-commerce businesses enhance customer satisfaction and reduce delivery-related support inquiries through intelligent logistics management.

Power end-to-end data operations for your Convey API with Nexla. Our bi-directional Convey connector is purpose-built for Convey, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Convey or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Convey workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Convey credential, you need to obtain an API key from your Convey account. The API key is required to authenticate with the Convey API.

To obtain your API key, you need to have a Convey account with API access enabled. Once you have access to your account, you can generate an API key from your account settings. Convey uses Basic Authentication with the API key as the username and an empty password to authenticate API requests. The API key is sent in the Authorization header for all API requests to the Convey API. For detailed information about API key setup and authentication, refer to the Convey API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
API Key	Yes	Yes	Your Convey API key

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Convey

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Convey API key in the API Key field. This is the API key you obtained from your Convey account settings. The API key is used as the username for Basic Authentication, with an empty password.

   Keep your API key secure and do not share it publicly. The API key provides access to your Convey account and should be treated as sensitive information. Convey uses Basic Authentication with the API key as the username and an empty password. The API key is sent in the Authorization header for all API requests to the Convey API. For detailed information about obtaining and managing API keys, see the Convey API documentation.

4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Convey connector tile, then select the credential that will be used to connect to the Convey instance, and click Next; or, create a new Convey credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Convey endpoints. Select the endpoint from which this source will fetch 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 data source for this endpoint.

Retrieve Shipment Events

This endpoint provides a route to retrieve shipment events. Both exceptions, tracking, and predictive events (enabled by configuration) are included. The system will return events from up to 72 hours ago in chronological order. Use this endpoint when you need to access shipment tracking events, exception events, or predictive events from your Convey account.

• This endpoint automatically retrieves shipment events from your Convey account. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses GET requests to https://api.getconvey.com/shipment/v1/events. The endpoint URL is automatically constructed based on the Convey API base URL.
• The endpoint uses URL-based pagination, automatically fetching additional pages as needed using the next_url from the response. When a response includes a result.pagination.next_url value, Nexla automatically uses it as the URL for the subsequent request to fetch the next page of results.
• The endpoint will return shipment events from up to 72 hours ago in chronological order. The response data is extracted from the result.events array in the API response ($.result.events[*]), with each event record processed individually.

This endpoint supports pagination through the next_url mechanism. When a response includes a result.pagination.next_url value, Nexla automatically uses it as the URL for the subsequent request to fetch the next page of results. The endpoint uses URL-based pagination (iteration.type: paging.next.url) through the result.pagination.next_url mechanism. The response data path is $.result.events[*], which extracts all items from the result.events array in the API response. The system returns events from up to 72 hours ago in chronological order. Both exceptions, tracking, and predictive events (enabled by configuration) are included. For detailed information about retrieving shipment events, see the Convey API documentation.

Export Shipment Information

This endpoint provides a route to export shipments, including destination and origin information. The API will return all shipments created on or after the From Date-Time parameter and ending at the current date-time. Use this endpoint when you need to export shipment data, including destination and origin information, for a specific time period.

• Enter the starting date/time value for exporting data in the From Date-Time field. This must be in ISO-8601 date time format (e.g., 2021-09-24T14:49:47Z). You can use Nexla macros like {now} for the current time or {now-1} for one day ago. The default value is {now-1} if not specified.

• The endpoint uses GET requests to https://api.getconvey.com/data/v1/shipment/export?from={'{from_datetime}'} where {from_datetime} is the From Date-Time you provide. The endpoint URL is automatically constructed based on the Convey API base URL and the provided date-time parameter.
• The endpoint does not use pagination and returns all shipments created on or after the From Date-Time parameter and ending at the current date-time in a single request.
• The endpoint will return all shipments created on or after the specified From Date-Time, including destination and origin information. The response data is extracted from the result array in the API response ($.result[*]), with each shipment record processed individually.

The From Date-Time parameter must be in ISO-8601 date time format (YYYY-MM-DDTHH:mm:ssZ), or you can use Nexla macros like {now} for the current time or {now-1} for one day ago. The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $.result[*], which extracts all items from the result array in the API response. The API will return all shipments created on or after the From Date-Time parameter and ending at the current date-time. For detailed information about exporting shipment information, see the Convey API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Convey data sources can also be manually configured to ingest data from any valid Convey API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, path to data, metadata, and request headers. Convey API endpoints typically follow the pattern https://api.getconvey.com/{'{endpoint_path}'}.

Basic Authentication with your API key as the username is handled automatically by your credential configuration. Convey API responses typically use a result object containing arrays such as events, or a root-level array, depending on the endpoint — use the Test button to verify that your Path to Data setting extracts the correct data.

Once all of the relevant settings have been configured, click the Save button to save your data source configuration. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.