A quick self-check to figure out whether your tech partner integration needs the Partner API, the Public API, or a mix of both, and which Public API key type to request.

Common scenarios

• 🧑‍💼 HR system
• 📝 Assessment tool
• 🔍 Background check

How candidates actually get sent to you: Triggers, not pull

A common assumption from partners is that they'll need to pull candidate data on demand (bulk pipeline import, refreshing a stage on request, re-fetching a candidate on request). That's technically possible, but it's not how we want integrations to work. Instead, everything is push-based, using Triggers.

Here's how it works:

• The customer sets up a Trigger on a specific pipeline stage (e.g. "Inbox"). Every time a candidate reaches that stage, they're automatically sent to your integration via the Partner API, including their current stage and rejection status (true/false).
• Triggers can also be set at the job template level, so they apply automatically to every new job created from that template. No need to configure it job by job.

The candidate's stage is already included in the Partner API payload for that candidate. You'll always know the stage of the specific candidate you're receiving, there's no need to separately pull or list all stages.

This means bulk pipeline import, on-demand stage refresh, and on-demand candidate re-fetch aren't needed. The trigger model replaces all three.

Read more: Triggers article

Custom fields: job vs candidate

There are two types of custom fields. As a tech partner, what you usually need are candidate custom fields, not job custom fields.

• Candidate custom fields → already included in the Partner API payload. No extra setup needed.
• Job custom fields → not included by default. If you specifically need these, reach out to us and explain your use case.

More on custom fields: support.teamtailor.com/en/articles/3468522-custom-fields