Airship is a customer engagement platform that helps brands build direct, lasting relationships with their app and web audiences. Airship's platform unifies push notifications, email, SMS, and in-app messaging so marketing and product teams can orchestrate personalized, cross-channel campaigns, automate journeys, and measure engagement across the full customer lifecycle.
Power end-to-end data operations for your Airship API with Nexla. Our bi-directional Airship connector is purpose-built for Airship, 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 Airship or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Airship 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
The Airship REST API supports two authentication approaches: Basic Auth using your App Key and Master Secret, or a Bearer Token generated from the Airship dashboard. Both credential types are managed from your Airship project's dashboard settings, and either grants Nexla the access it needs to read and write data through the Airship API.
Sign in to your Airship dashboard at https://go.urbanairship.com (US cloud site) or https://go.airship.eu (EU cloud site), depending on the region in which your Airship project is provisioned.
Select the project (app) you want to connect from the project picker at the top of the dashboard.
Click the Settings tab, then select APIs & Integrations from the dropdown options.
On the APIs & Integrations page, locate your App Key and Master Secret.
Airship also displays an App Secret on this page. The App Secret is restricted to a limited set of low-security operations because it is designed to be embedded in distributed mobile app bundles. Use the Master Secret instead, which is intended for authenticating server-side API requests such as the ones Nexla makes on your behalf, and should never be published or embedded in an app.
As an alternative to Basic Auth, Airship also supports role-scoped Bearer Tokens that can be revoked independently of your Master Secret.
Sign in to your Airship dashboard.
Click the Settings tab, then select Users from the dropdown options.
Navigate to the Personal Access Tokens section of the Users page.
Click Create Token, assign the token a descriptive name, and select the roles/permissions the token should carry. Airship scopes each token to specific API capabilities, so choose only the permissions your Nexla flows require.
Copy the generated token immediately.
Token visibility
Airship displays the full Bearer Token only once, at the time it is created. If you lose the token, you will need to revoke it and generate a new one.
Airship operates separate cloud sites for the US and EU. Confirm which site your project belongs to before configuring the credential, since API requests must be sent to the matching base URL.
Use https://go.urbanairship.com if your Airship project is hosted on the US cloud site.
Use https://go.airship.eu if your Airship project is hosted on the EU cloud site.
After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
Airship credentials in Nexla can be configured using either Basic Auth with your Master Secret or a Bearer Token. Select the tab below that corresponds to the method you will use, and complete the listed steps to finish configuring the credential.
Airship Authentication Methods
Basic Auth (Master Secret)
Bearer Token
Authenticate using your Airship App Key and Master Secret. Nexla Base64-encodes these values and sends them as a Basic Auth header, granting full access to the Airship API.
3. Enter your Airship **App Key** in the **App Key** field. This is the identifier for your Airship project, found on the APIs & Integrations page in your Airship dashboard.
4. Enter your Airship **Master Secret** in the **Master Secret** field. This secret authenticates server-side requests to the Airship API and should be kept secure at all times.
5. Enter the base URL that corresponds to your Airship project's cloud site in the **Base URL** field. Use `https://go.urbanairship.com` for projects on the US cloud site, or `https://go.airship.eu` for projects on the EU cloud site.
Authenticate using a role-scoped Bearer Token generated from the Airship dashboard. Tokens can be revoked independently of your Master Secret, making this a good option when you want to limit or audit Nexla's access separately from other integrations.
3. Enter the Bearer Token generated from your Airship dashboard in the **Bearer Token** field. This token was created under Users > Personal Access Tokens and authenticates requests according to the permissions selected when it was generated.
4. Enter the base URL that corresponds to your Airship project's cloud site in the **Base URL** field. Use `https://go.urbanairship.com` for projects on the US cloud site, or `https://go.airship.eu` for projects on the EU cloud site.
All Airship API requests require the header Accept: application/vnd.urbanairship+json; version=3 to specify the API version. Nexla automatically includes this header for both authentication methods, so no additional configuration is required.
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.
The Airship connector enables you to ingest audience, messaging, and reporting data from your Airship project, including channels, named users, segments, lists, templates, automation pipelines, and engagement reports. This connector is particularly useful for applications that need to sync audience metadata into a warehouse, build engagement dashboards, or feed downstream analytics and CRM systems with Airship activity data.
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Airship connector tile, then select the credential that will be used to connect to the Airship instance, and click Next; or, create a new Airship credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Airship 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.
List Attribute Lists
Retrieves metadata for all attribute lists uploaded to your Airship project, such as list name, status, and record counts. Use this endpoint to monitor bulk attribute uploads used to enrich channel or named user profiles.
No additional parameters are required. The endpoint automatically pages through all available attribute lists using Airship's next-page cursor.
Retrieves the errors generated during the most recent upload of a specific attribute list. Use this endpoint to troubleshoot rows in a bulk attribute upload that failed validation.
Enter the name of the attribute list to check in the list_name path parameter. This is the same name used when the attribute list was created in Airship.
Retrieves a listing of all channels (device tokens, email addresses, SMS numbers, and other addressable endpoints) associated with your Airship project. Use this endpoint to sync your full audience of addressable channels into Nexla.
Optionally, enter a value in the Limit field to control the maximum number of channels returned per page. If left blank, Airship applies its default page size.
The endpoint uses Airship's next-page cursor to automatically retrieve all pages of channel data.
Retrieves a paginated list of content templates, which are reusable content blocks used to build push, email, and in-app messages. Use this endpoint to inventory the reusable content assets configured in your Airship project.
Optionally, enter values in the Page and Page Size fields to control which page of results is returned and how many content templates are included per page.
Retrieves a listing of A/B test experiments configured in your Airship project, including variant details and experiment status. Use this endpoint to analyze the results of message experiments.
Optionally, enter values in the Limit and Offset fields to control pagination of the returned experiments.
Retrieves metadata for all static lists in your Airship project. Static lists are named audiences uploaded in bulk (for example, via CSV) and are commonly used to target campaigns at specific customer segments.
No additional parameters are required. The endpoint automatically pages through all available static lists.
Downloads the CSV data for a specific static list, including the channel or named user identifiers that make up the list. Use this endpoint to extract the current membership of a static list.
Enter the name of the static list to download in the list_name path parameter. This is the name assigned to the list when it was created in Airship.
Looks up named user associations in your Airship project. Named users are identity-agnostic identifiers (such as a customer ID) that Airship uses to unify multiple channels belonging to the same customer.
No additional parameters are required for this endpoint template.
Retrieves a listing of automation pipelines (Journeys) configured in your Airship project. Use this endpoint to inventory active customer journeys and automation workflows.
Optionally, enter values in the Limit and Offset fields to control pagination of the returned pipelines.
Optionally, enter a value in the Enabled field to filter pipelines by whether they are currently active.
Retrieves a listing of automation pipelines that have been deleted from your Airship project. Use this endpoint to maintain an audit trail of removed automations.
Optionally, enter a value in the Start field to specify a cursor from which to begin retrieving deleted pipelines.
Optionally, enter a value in the Limit field to control the maximum number of deleted pipelines returned per page.
Retrieves a filtered listing of automation pipelines based on criteria supported by the Airship Automation API. Use this endpoint when you need to narrow down pipeline results beyond a simple enabled/disabled filter.
No additional parameters are required for this endpoint template.
Retrieves a listing of geofence regions configured in your Airship project. Regions are used to trigger location-based messaging when a device enters or exits a defined geographic area.
Optionally, enter a value in the Limit field to control the maximum number of regions returned per page.
Optionally, enter a value in the Start field to specify a cursor from which to begin retrieving regions.
Retrieves activity log data describing actions taken within your Airship project, such as message sends and configuration changes. Use this endpoint for auditing and compliance reporting.
No additional parameters are required for this endpoint template.
Retrieves device counts report data, including counts of opted-in and opted-out devices across platforms. Use this endpoint to track audience growth and opt-in trends over time.
Optionally, enter a value in the Date field, in YYYY-MM-DD format, to retrieve device counts as of a specific date. If omitted, Airship returns the most recent counts.
Retrieves custom events that have been recorded for your Airship project, such as purchases or in-app actions submitted through the Custom Events API or SDKs. Use this endpoint to analyze audience behavior alongside messaging performance.
Optionally, enter values in the Start and End fields, in ISO 8601 format, to limit results to events that occurred within a specific time range.
Optionally, enter values in the Page and Page Size fields to control pagination of the returned events.
Retrieves opt-in report data, showing the number of channels that opted in to receive messages over a given period. Use this endpoint to monitor audience growth.
Optionally, enter values in the Start and End fields, in ISO 8601 format, to limit results to a specific time range.
Retrieves opt-out report data, showing the number of channels that opted out of receiving messages over a given period. Use this endpoint to monitor churn and unsubscribe trends.
Optionally, enter values in the Start and End fields, in ISO 8601 format, to limit results to a specific time range.
Retrieves push response report data, showing how audiences responded to individual push notifications (direct responses and influenced opens). Use this endpoint to measure the effectiveness of specific messages.
Optionally, enter values in the Start and End fields, in ISO 8601 format, to limit results to a specific time range.
Retrieves a listing of push response reports, one per push, so you can compare engagement across multiple sends. Use this endpoint to build historical dashboards of push performance.
Optionally, enter values in the Start, End, and Limit fields to control the time range and pagination of the returned pushes.
Retrieves push send report data, summarizing the number of pushes sent across your project over a given period. Use this endpoint to track overall send volume.
Optionally, enter values in the Start and End fields, in ISO 8601 format, to limit results to a specific time range.
Retrieves time-in-app report data, showing how much time users spent in your app following a push notification. Use this endpoint to correlate messaging with in-app engagement.
Optionally, enter values in the Start and End fields, in ISO 8601 format, to limit results to a specific time range.
Retrieves web notification interaction report data, showing how audiences responded to web push notifications. Use this endpoint to measure the performance of your web push campaigns.
Optionally, enter a value in the App Key field to scope results to a specific web project, if your Airship account manages multiple web projects.
Optionally, enter values in the Start and End fields, in ISO 8601 format, to limit results to a specific time range.
Optionally, enter a value in the Precision field to control the time granularity (for example, hourly or daily) of the returned data.
Retrieves a listing of scheduled messages configured in your Airship project, including their delivery time and payload. Use this endpoint to audit or synchronize upcoming scheduled sends.
Optionally, enter values in the Start and Limit fields to control the starting point and page size of the returned schedules.
Retrieves a listing of audience segments defined in your Airship project. Segments are saved audience definitions built from tags, attributes, or other selectors, and are commonly reused across campaigns.
Optionally, enter a value in the Limit field to control the maximum number of segments returned per page.
Retrieves a listing of subscription lists in your Airship project. Subscription lists let users opt in or out of specific categories of messaging (for example, promotions versus order updates) independently of their overall opt-in status.
No additional parameters are required. The endpoint automatically pages through all available subscription lists.
Retrieves metadata for all tag lists uploaded to your Airship project. Tag lists are used to bulk-apply tags to channels or named users for targeting purposes.
No additional parameters are required. The endpoint automatically pages through all available tag lists.
Retrieves the errors generated during the most recent upload of a specific tag list. Use this endpoint to troubleshoot rows in a bulk tag upload that failed validation.
Enter the name of the tag list to check in the list_name path parameter. This is the same name used when the tag list was created in Airship.
Retrieves a paginated list of push templates configured in your Airship project. Push templates are reusable message definitions that standardize formatting across campaigns.
Optionally, enter values in the Page and Page Size fields to control which page of results is returned and how many templates are included per page.
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.
Airship data sources can also be manually configured to ingest data from any valid Airship 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, date/time and lookup macros, path to data, metadata, and request headers.
Airship API endpoints typically follow the pattern https://go.urbanairship.com/api/{resource}, where {resource} is the resource you want to access (for example, channels, segments, or named_users). Ensure the endpoint URL matches the cloud site (US or EU) configured in your credential. For responses that include a top-level array containing the relevant data—for example, a channels array—enter the corresponding JSON path (e.g., $.channels[*]) in the Set Path to Data in Response field. You do not need to include any headers already present in the credentials—the required Accept: application/vnd.urbanairship+json; version=3 and authentication headers are already included in your Airship credential, so you only need to add headers specific to an individual endpoint. For a complete list of available Airship API endpoints, see the Airship REST API reference.
Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Airship data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.
Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a data flow that sends data to an Airship location, such as sending push, email, and SMS messages, updating channel and named user attributes and tags, or ingesting custom events into your Airship project.
Click the + icon on the Nexset that will be sent to the Airship destination, and select the Send to Destination option from the menu. Select the Airship connector from the list of available destination connectors, then select the credential that will be used to connect to the Airship project, and click Next; or, create a new Airship credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Airship endpoints. 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.
Send Push
Sends a push notification, email, or SMS message to a specified audience through the Airship Push API. Use this endpoint to trigger one-off or event-driven messages directly from a Nexla flow.
Map the Nexset attributes that define the message payload—including audience, device_types, and notification content—to the corresponding fields required by the Airship Push API request body.
For the complete request body schema, including audience selectors and supported notification overrides per channel, see the Airship Push API documentation.
Create Schedule
Schedules a message for future delivery instead of sending it immediately. Use this endpoint when messages need to go out at a specific time or on a recurring schedule.
Map the Nexset attributes that define the scheduled push payload, including the schedule object (specifying the delivery time) and the push object (specifying the message content and audience), to the corresponding request body fields.
Registers or opts in an email address as an Airship channel. Use this endpoint to sync newly captured email addresses from your Nexset into Airship so they can immediately receive email campaigns.
Map the Nexset attributes containing the recipient's address and opt-in details to the corresponding fields in the email channel registration request body.
Registers or opts in a phone number as an Airship SMS channel. Use this endpoint to sync newly captured phone numbers from your Nexset into Airship so they can receive SMS campaigns.
Map the Nexset attributes containing the recipient's msisdn (phone number) and sender details to the corresponding fields in the SMS channel registration request body.
Adds or removes tags on one or more channels. Use this endpoint to keep channel-level tags in Airship synchronized with segmentation data maintained elsewhere in your data pipeline.
Map the Nexset attributes identifying the target channels and the tags to add or remove to the audience and add/remove fields in the request body.
Sets or removes custom attributes on one or more channels. Use this endpoint to push profile data, such as loyalty tier or lifetime value, from your Nexset into Airship for use in audience targeting.
Map the Nexset attributes identifying the target channels and the attribute key/value pairs to set or remove to the audience and attributes fields in the request body.
Adds or removes tags on one or more named users. Use this endpoint when tags should follow a customer across all of their associated channels rather than being scoped to a single channel.
Map the Nexset attributes identifying the target named users and the tags to add or remove to the audience and add/remove fields in the request body.
Sets or removes custom attributes on a single named user. Use this endpoint to keep customer-level profile data synchronized across every channel associated with that named user.
Enter the identifier of the named user to update in the named_user_id path parameter, mapped from the corresponding Nexset attribute.
Map the Nexset attributes containing the attribute key/value pairs to set or remove to the attributes field in the request body.
Creates a new audience segment in your Airship project. Use this endpoint to programmatically build reusable audience definitions based on data maintained in your Nexset.
Map the Nexset attributes defining the segment's display_name and criteria (the selector logic that determines segment membership) to the corresponding fields in the request body.
Creates a new push template in your Airship project. Use this endpoint to programmatically publish reusable message templates managed outside of Airship.
Map the Nexset attributes defining the template's name and push content to the corresponding fields in the request body.
Creates a new static list for bulk audience upload. Use this endpoint to establish a named list container in Airship before uploading channel or named user identifiers to it.
Map the Nexset attribute containing the desired list name to the name field in the request body.
Ingests custom events for audience segmentation and analytics processing. Use this endpoint to feed behavioral data, such as purchases or content views, from an external system into Airship.
Map the Nexset attributes defining the event's occurred timestamp, user or channel identifier, and body (event name and properties) to the corresponding fields in the request body.
Associates a channel with a contact for identity resolution. Use this endpoint to link a channel (such as a device or email address) to a known customer identity managed outside Airship.
Map the Nexset attributes identifying the channel_id and the external contact identifier to the corresponding fields in the request body.
Creates a new tag list for bulk tag upload. Use this endpoint to establish a named tag list container in Airship before uploading channel or named user tag associations to it.
Map the Nexset attribute containing the desired tag list name to the name field in the request body.
Airship destinations can also be manually configured to send data to any valid Airship API endpoint, including other resources exposed in the Airship REST API reference that are not covered by a pre-built template. 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, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.
Airship's REST API accepts JSON request bodies for all messaging and audience operations, and most Airship write operations use the POST method. Enter the endpoint URL using the base URL that matches your project's cloud site (https://go.urbanairship.com for US or https://go.airship.eu for EU). For update/upsert operations, include the ID of the object to be updated at the end of the URL (for example, the named user ID when updating named user attributes). You do not need to include any headers already present in the credentials—the required Accept: application/vnd.urbanairship+json; version=3 and authentication headers are already included in your Airship credential.
Record batching is particularly useful for endpoints such as Modify Channel Tags and Modify Named User Tags, which accept multiple audience identifiers in a single Airship API call, since it reduces the total number of requests sent to the API. Enabling the response webhook option allows you to keep track of the status of each API call and any additional information returned after each call, such as the push_ids returned when sending a push.
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 send Nexset data to Airship, open the destination resource menu, and select Activate.
Nexset data will not be sent to Airship until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.