.png)
Teamtailor Integration Guide
Integrate Teamtailor with enterprise systems through its JSON:API-based REST API, API-key authentication, and selected webhook event notifications.
Teamtailor integration options at a glance
Teamtailor provides a REST API using JSON:API conventions for retrieving and, where permitted, creating or updating Jobs, Candidates, Applications, Users, Departments, and Locations. It also supports webhook-style notifications for selected recruitment events, although event coverage and delivery behavior should be verified for the account. API-key authentication uses the Teamtailor token format in the Authorization header. Martini can consume the REST API, handle JSON:API relationships and pagination, receive webhook notifications through an exposed endpoint, and orchestrate scheduled or event-driven workflows. Large synchronizations should use paginated requests, checkpoints, bounded concurrency, and retry handling rather than an assumed bulk API.
Common Teamtailor integration patterns
Common Teamtailor data objects used in integrations
Authentication and security considerations
API-key authentication
Teamtailor documents API-key authentication using the Authorization header format specified by its API documentation. Store the key in Martini secrets or protected environment configuration rather than workflow mappings or source-controlled files.
Protecting candidate data
Candidates, Applications, resumes, contact information, and interview information may contain personal or sensitive data. Limit copied fields, restrict workflow and API access, redact sensitive values from logs, and define retention and deletion behavior with downstream owners.
Controlled API exposure
When other systems need Teamtailor data, Martini can expose a controlled API façade instead of distributing the Teamtailor API key. Apply authentication, authorization, validation, and request-specific routing at the Martini boundary.
Operational considerations for Teamtailor integrations
Pagination and checkpoints
Treat Teamtailor collection responses as paginated and follow returned links or metadata. Store a timestamp, resource identifier, or page checkpoint where supported, and avoid repeatedly extracting the full candidate or application population.
Rate limits and retries
Confirm current request limits and response-header behavior for the account. Use bounded concurrency and exponential backoff for transient 429 and 5xx responses, while avoiding retries for authentication or validation failures without changing the request.
JSON:API relationships
Do not assume related resources are embedded in every response. Handle relationships, included resources, relationship links, and follow-up requests explicitly.
Idempotency and schema changes
Use event IDs when available, or combine event type, resource type, resource ID, and event time to detect duplicate notifications. Validate identifiers and required fields, treat statuses as configurable values, and test mappings against representative Teamtailor payloads.
Testing and monitoring
Test Jobs, Candidates, Applications, Users, Departments, and Locations with realistic relationships and failure responses. Monitor workflow logs, isolate page-level failures, and preserve enough source and target identifiers to troubleshoot safely.
Why use Martini instead of scripts or point-to-point integrations?
Orchestration beyond a script
Martini coordinates Teamtailor API calls, webhook intake, pagination, relationship retrieval, target writes, business rules, and error paths in a visible workflow rather than scattering behavior across custom scripts.
Reusable integration assets
Teams can centralize authentication, mappings, validation, retry behavior, and API façade logic so multiple Teamtailor processes follow consistent standards.
Reliable data movement
Scheduled and event-driven workflows can use checkpoints, idempotency keys, controlled concurrency, and operational logging to make synchronization more repeatable than ad hoc point-to-point code.
Flexible enterprise integration
Martini can transform JSON:API data, connect to APIs and databases, route records according to business rules, and extend workflows with custom logic when the Teamtailor API or target-system requirements demand it.