Skip to main content

Coalesce

Coalesce is a Snowflake-native data transformation platform used to build, deploy, and orchestrate data pipelines. The Coalesce API exposes pipeline metadata — environments, nodes, projects, Git accounts, users, and run history — and lets you trigger, rerun, and cancel deploy and refresh runs programmatically.

Coalesce icon

Power end-to-end data operations for your Coalesce API with Nexla. Our bi-directional Coalesce connector is purpose-built for Coalesce, 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 Coalesce or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Coalesce 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 Coalesce credential, you need a Coalesce access token and the base URL for your deployment region. The Coalesce API uses Bearer authentication: the access token is sent in the Authorization: Bearer <token> header on every request.

To obtain your Coalesce access token, follow these steps:

  1. Sign in to the Coalesce web app for your organization's deployment region.

  2. Open the Deploy tab in the Coalesce interface.

  3. Click Generate Access Token to create a new token, or copy an existing token if one has already been generated.

  4. Copy the access token and store it securely, as you will need it to configure your Nexla credential.

  5. Identify the base URL for your deployment region. Coalesce runs several regional hosts, for example https://app.coalescesoftware.io (US, default), https://app.eu.coalescesoftware.io (Europe), or https://app.us-east-1.aws.coalescesoftware.io. Use the host shown in your organization's Deploy settings. If your organization signs in through SSO, your host may be prefixed with your company subdomain (e.g. https://yourcompany.app.eu.coalescesoftware.io).

Coalesce access tokens do not expire and are not invalidated by re-issuing — a token remains valid even after a new one is generated. Tokens are invalidated only when the associated user account is deleted or disabled, or when the account's password, email, or multi-factor authentication settings are changed. Treat the token as sensitive information and rotate it if it is exposed.

For complete information about Coalesce API authentication, access tokens, and regional base URLs, see the Coalesce API Documentation and the Getting Your Token guide.

Authenticate

Credentials required

FieldRequiredSecretDescription
Access TokenYesYesBearer access token generated from the Deploy tab in Coalesce (Settings > Deploy > Generate Access Token).
Base URLYesNoCoalesce app base URL for your deployment region, e.g. https://app.coalescesoftware.io (default). Coalesce runs many regional hosts -- use the host from your org's Deploy settings.

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.

  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 Coalesce access token in the Access Token field. This is the Bearer token you generated from the Deploy tab in Prerequisites. It is sent in the Authorization header on every request to the Coalesce API and must be kept confidential.

  4. Enter the base URL for your deployment region in the Base URL field. This defaults to https://app.coalescesoftware.io. Use the host shown in your organization's Coalesce Deploy settings, as Coalesce runs several regional hosts.

  5. 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 Coalesce connector tile, then select the credential that will be used to connect to Coalesce, and click Next; or, create a new Coalesce 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 Coalesce 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.

[Rest API] Environments

Retrieves the list of Coalesce Environments (deployed workspace targets), including id, name, status, project, and creation metadata.

  • This endpoint requires no additional parameters. Nexla automatically follows cursor-based pagination to retrieve all available environments.

For detailed information about environments and the response structure, see the Coalesce API Documentation.

[Rest API] Environment Nodes

Retrieves the collection of Nodes (transforms/tables) deployed to a given Coalesce Environment, including node id, name, type, database, schema, and location.

  • Enter the Environment ID — the id of the Coalesce Environment whose nodes you want to ingest. Available ids can be found using the Environments endpoint above.
  • Nexla automatically follows cursor-based pagination to retrieve all nodes in the environment.

For detailed information about environment nodes and the response structure, see the Coalesce API Documentation.

[Rest API] Workspace Nodes

Retrieves the collection of Nodes (transforms/tables) defined in a given Coalesce Workspace (the design-time equivalent of environment nodes).

  • Enter the Workspace ID — the id of the Coalesce Workspace containing the nodes.
  • Nexla automatically follows cursor-based pagination to retrieve all nodes in the workspace.

For detailed information about workspace nodes and the response structure, see the Coalesce API Documentation.

[Rest API] Runs

Retrieves Coalesce run history (deploys and refreshes) across environments, including run status, type, and timing, for monitoring pipeline execution.

  • This endpoint requires no additional parameters. Nexla automatically follows cursor-based pagination to retrieve run history.

For detailed information about runs and the response structure, see the Coalesce API Documentation.

[Rest API] Run

Retrieves details of a single Coalesce run by its numeric run id.

  • Enter the Run ID — the numeric id of the Coalesce run to retrieve. Available ids can be found using the Runs endpoint above.

For detailed information about a single run and the response structure, see the Coalesce API Documentation.

[Rest API] Run Results

Retrieves the per-node results of a single Coalesce run, including success/failure status for each executed node.

  • Enter the Run ID — the numeric id of the Coalesce run whose per-node results you want to retrieve. Available ids can be found using the Runs endpoint above.

For detailed information about run results and the response structure, see the Coalesce API Documentation.

[Rest API] Projects

Retrieves the list of Coalesce Projects, optionally including their workspaces and jobs.

  • This endpoint requires no additional parameters. It returns projects along with their associated workspaces and jobs.

For detailed information about projects and the response structure, see the Coalesce API Documentation.

[Rest API] Git Accounts

Retrieves the list of version-control (Git) accounts connected to the Coalesce organization.

  • This endpoint requires no additional parameters.

For detailed information about Git accounts and the response structure, see the Coalesce API Documentation.

[Rest API] Users

Retrieves the list of users in the Coalesce organization.

  • This endpoint requires no additional parameters. Nexla automatically follows cursor-based pagination to retrieve all users.

For detailed information about users and the response structure, see the Coalesce API Documentation.

[Rest API] Run Status

Polls the status (completed, running, failed, canceled, etc.) of a run previously started via Start Run or Rerun.

  • Enter the Run Counter — the runCounter value returned by the Start Run or Rerun destination endpoint, used to poll the status of that run.

For detailed information about run status polling and the response structure, see the Coalesce 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

Coalesce data sources can also be manually configured to ingest data from any valid Coalesce 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.

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 Coalesce 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.

Use as a destination

Click the + icon on the Nexset that will be sent to the Coalesce destination, and select the Send to Destination option from the menu. Select the Coalesce connector from the list of available destination connectors, then select the credential that will be used to connect to Coalesce, and click Next; or, create a new Coalesce credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Coalesce 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.

[Rest API] Start Run

Starts a Coalesce deploy/refresh run for an environment using records from a Nexset.

  • Each record is sent as a JSON request body. The body carries runDetails (such as the environmentID and node selectors or jobID) and userCredentials (the Snowflake credentials Coalesce uses to execute the run).
  • The response includes a runCounter value that can be used with the Run Status source endpoint to poll the status of the run.

Ensure each Nexset record matches the request body format expected by Coalesce. For detailed information about the request body and required fields, see the Coalesce API Documentation.

[Rest API] Rerun

Retries a previously failed Coalesce run by run id using records from a Nexset.

  • Each record is sent as a JSON request body. The body carries runDetails (the runID to retry, plus optional forceIgnoreWorkspaceStatus) and userCredentials.

For detailed information about the request body and required fields, see the Coalesce API Documentation.

[Rest API] Cancel Run

Cancels an in-progress Coalesce run by run id using records from a Nexset.

  • Each record is sent as a JSON request body identifying the runID of the in-progress run to cancel.

For detailed information about the request body and required fields, see the Coalesce API Documentation.

[Rest API] Create Environment

Creates a new Coalesce Environment (deployed workspace target) using records from a Nexset.

  • Each record is sent as a JSON request body describing the environment to create.

For detailed information about the request body and required fields, see the Coalesce API Documentation.

[Rest API] Create Workspace Node

Creates a new Node (transform/table definition) in a Coalesce Workspace using records from a Nexset.

  • Enter the Workspace ID — the id of the Coalesce Workspace in which the new node will be created.
  • Each record is sent as a JSON request body describing the node to create.

For detailed information about the request body and required fields, see the Coalesce API Documentation.

Manual configuration

Coalesce destinations can also be manually configured to send data to any valid Coalesce API endpoint. 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.

Coalesce write endpoints expect JSON request bodies. Ensure your Nexset records match the structure required by the target Coalesce endpoint before activating the destination.

Save & activate

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 the data to the configured Coalesce endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Coalesce endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.