Batch
Find your Batch REST and project keys, then share campaigns and their statistics.
Persyst needs two values: the REST API Key, which authenticates the connection, and the Project Key, which identifies the project to read. Authorized members can read its orchestrations and statistics from their assistant without a Batch account.
Find the keys in Batch
The person retrieving the REST key needs Administrate rights in Batch. They can complete this step without a Persyst account.
- Open the Batch dashboard and select the project.
- Open Settings → General.
- Copy the project’s Project Key and the REST API Key from the API keys section.
Use the REST key: the SDK API Key, SDK Auth Key and Inbox secret serve other purposes.
Connect the project in Persyst
- In Data sources, click Add a source and choose Batch.
- Give the connection a recognizable name, such as
Batch — production. - Enter the Project Key in Project key and the REST API Key in API key.
- Click Test, then Create connector once the test succeeds.
- Open Access management to grant the source and tools to the relevant teams or members.
For individual use, Batch can also be added from My connectors. This personal connection is not shared with the organization.
Verify usage
After connecting their assistant, an authorized member can ask: “List the Batch project’s orchestrations, then show this campaign’s statistics for the last seven days.”
The connector does not create, change or send campaigns. It does not provide access to profiles or audiences.
Renew the key
Batch states that only one REST key is valid per company. Renewal goes through Batch support and may affect other integrations using it. Coordinate the replacement with their owner before reconnecting the project in Persyst.
References: Batch project API keys, settings and REST key renewal.