Skip to main content

Batch

Overview​

Batch is a customer engagement platform. This connector documentation covers Batch support in this repo.

Supported connectors​

Source​

Not currently available.

Destination​

  • Batch Conversions API (Reverse ETL destination)
    • Status: Credential validation supported; loading is still in development.

Destination: Batch Conversions API​

Use this destination to connect to Batch’s APIs using a REST API key and project key. At this time, the connector can validate credentials during setup, but it does not yet send records to Batch.

Setup​

  1. In Batch, obtain:
    • A REST API key
    • A Project key
  2. In your workspace, create a new destination and select Batch Conversions API.
  3. Enter the credentials and run the connection test.

Authentication​

The connector authenticates using:

  • Bearer token: Authorization: Bearer <REST_API_KEY>
  • Project header: X-Batch-Project: <PROJECT_KEY>

During credential validation, the connector calls:

  • GET https://api.batch.com/2.0/audiences/list

If the request fails, setup will report a credential validation error.

Configuration fields​

FieldTypeRequiredDescription
rest_api_keystringYesBatch REST API key used as the Bearer token.
project_keystringYesBatch project key sent in the X-Batch-Project header.

Hashing and normalization​

This destination does not currently expose field-level hashing configuration.

Data contract​

Not yet available. The destination load path is still in development, so there is no stable, documented record schema or mapping at this time.

Streams / objects​

Not yet available.