.png)
SmartRecruiters Integration Guide
Connect SmartRecruiters recruiting data with enterprise applications through REST APIs, selected webhook notifications, scheduled workflows, and secure data transformation.
SmartRecruiters integration options at a glance
SmartRecruiters primarily integrates through REST APIs for Jobs, Candidates, Applications, Hiring Processes, Users, Departments, and related recruiting resources. Selected recruiting events can generate webhook-style notifications, which Martini can receive through an exposed API endpoint before retrieving the current resource from SmartRecruiters. Scheduled workflows support paginated synchronization and checkpoint-based reconciliation. Candidate documents and attachments can be transferred where the relevant endpoint and permissions are available. Authentication may use OAuth 2.0 or SmartRecruiters-issued API credentials, depending on the account and API product. Martini stores credentials securely, transforms JSON payloads, applies recruiting business rules, and delivers data to downstream APIs, databases, files, or messaging systems.
Common SmartRecruiters integration patterns
Common SmartRecruiters data objects used in integrations
Authentication and security considerations
Tenant and application authorization
SmartRecruiters access is limited by the authorized company or tenant, API product, scopes, and account permissions. Confirm the required access to Jobs, Candidates, Applications, Users, Departments, and attachments before implementation.
Credential protection
Martini should store OAuth client secrets, refresh tokens, API keys, and other credentials in environment-specific secrets rather than embedding them in workflows.
Recruiting data protection
- Minimize candidate and application fields copied to downstream systems.
- Restrict access to résumés, cover letters, contact details, and interview information.
- Protect webhook endpoints using the authentication or signature requirements confirmed for the SmartRecruiters account.
- Define retention, deletion, and audit behavior across all participating systems.
Operational considerations for SmartRecruiters integrations
Rate limits and pagination
Treat SmartRecruiters list endpoints as paginated and confirm tenant-specific request limits. Control concurrency, use backoff for HTTP 429 and transient 5xx responses, and process every page before advancing a checkpoint.
Events and reconciliation
Webhook-style notifications cover selected events and may contain only an identifier. Combine event processing with scheduled reconciliation, and confirm delivery retries, ordering, subscription management, and authentication requirements.
Idempotency and status mapping
Use stable SmartRecruiters identifiers and source-to-target mappings to prevent duplicate Candidates, Applications, Jobs, or documents. Maintain explicit mappings for open, closed, rejected, withdrawn, hired, and archived statuses.
Schema and attachment changes
Handle optional fields and custom recruiting stages defensively, monitor API version changes, and verify attachment endpoints, file limits, content types, and permissions before transferring documents.
Monitoring and testing
Monitor synchronization lag, failed pages, webhook errors, rejected records, retries, and checkpoint state. Log correlation IDs and resource identifiers without exposing unnecessary personally identifiable information.
Why use Martini instead of scripts or point-to-point integrations?
Orchestration beyond point-to-point calls
Martini coordinates SmartRecruiters API calls, webhook intake, pagination, enrichment, target writes, and reconciliation in maintainable workflows rather than scattering logic across scripts.
Reusable integration assets
Teams can expose controlled APIs, reuse authentication and transformation logic, and apply consistent validation, status mapping, idempotency, and exception handling across recruiting processes.
Operational control
Scheduled execution, checkpoints, retries, monitoring, and environment-specific secrets provide a stronger operational model for candidate, application, job, and document synchronization than isolated scripts.
Flexible enterprise delivery
Martini can map SmartRecruiters JSON and files to downstream APIs, databases, analytics stores, and messaging systems while allowing custom business logic where the recruiting process requires it.