Skip to main content
This guide walks through creating a campaign, adding contacts, and launching it programmatically. Use it as a template.

Prerequisites

  • A workspace API key with the interviews scope. See Authentication.
  • A list of contacts (name + email at minimum).

End-to-end script

Knowing when it’s done

Don’t poll. Subscribe to the synthesis.completed webhook — it fires once the synthesis pipeline finishes, and the report is queryable immediately after.
If you can’t run a webhook receiver, fall back to polling GET /v1/interviews/{id} every minute and watching the status field — but webhooks are strongly preferred.

Common follow-ups