--- title: Zwayam API Integration on Truto slug: zwayam category: HRIS canonical: "https://truto.one/integrations/detail/zwayam/" --- # Zwayam API Integration on Truto **Category:** HRIS **Status:** Generally available ## Unified APIs ### Unified HRIS API - **Employees** — Represents an employee in HRIS ## How it works 1. **Link your customer's Zwayam account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach Zwayam.** The Proxy API is a 1-to-1 mapping of the Zwayam API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Automate hired-candidate-to-employee provisioning** — Core HR and payroll platforms can sync candidates who reach 'Offer Accepted' or 'Hired' status in Zwayam directly into their system as new employee records, eliminating manual re-entry of names, emails, phone numbers, and department data. - **Trigger zero-touch IT onboarding from hiring decisions** — IT provisioning and access management tools can listen for new hires flowing out of Zwayam and automatically spin up email accounts, order hardware, and configure app access before day one — all driven by the TA team's activity in the ATS. - **Close the loop on background verification workflows** — Background check platforms can pull candidate PII and uploaded documents from Zwayam, run verification checks externally, and push pass/fail status codes back so recruiters never leave the ATS to track BGV progress. - **Sync open requisitions into referral and talent marketplace apps** — Employee referral and internal mobility platforms can fetch active job requisitions from Zwayam daily, display them to employees, and push referred candidates back into the correct req with proper source attribution. - **Enrich workforce planning with pipeline data** — Workforce planning and org-chart tools can combine current employee headcount from the HRIS with open requisitions and candidates in final stages from Zwayam, giving Finance and HR a real-time view of future headcount and budget impact. ## What you can build - **Automatic employee record creation on hire** — When a candidate's status in Zwayam moves to 'Hired,' automatically create a corresponding employee record in your product using Truto's Unified HRIS API for Employees. - **Real-time new-hire event listener** — Poll Zwayam for candidates transitioning through hiring stages and trigger downstream workflows — IT provisioning, benefits enrollment, or onboarding task generation — the moment a hire is confirmed. - **Candidate-to-employee data mapping dashboard** — Surface a configuration UI that lets your customers map Zwayam candidate fields (name, email, department, start date) to your product's employee schema, ensuring clean data flow without manual CSV imports. - **BGV status write-back from your verification platform** — After completing a background check, push a structured status update (e.g., GREEN, AMBER, RED) back into the candidate's Zwayam profile so recruiters see results inline without switching tools. - **Open requisition sync for referral programs** — Automatically pull active job requisitions from Zwayam on a scheduled cadence and display them inside your referral or internal mobility product, keeping listings current without manual publisher intervention. - **Unified employee directory populated from Zwayam hires** — Build a continuously updated employee directory by reading employee data through Truto's Unified HRIS API, combining existing headcount with recently onboarded hires originating from Zwayam. ## FAQs ### Does Truto have pre-built tools for the Zwayam API today? Zwayam tools are built on request. Once you signal interest, Truto's team builds and tests the connector — typically covering auth setup, pagination handling, and mapping to the Unified HRIS API — so you don't have to reverse-engineer Zwayam's API yourself. ### Which Unified API does the Zwayam integration map to? Zwayam maps to Truto's Unified HRIS API, specifically the Employees standard object. This lets you read and write employee data using a consistent schema regardless of whether the underlying system is Zwayam or another HRIS. ### How does authentication work for connecting an end user's Zwayam account? Truto manages the full auth flow on your behalf. The specific auth mechanism (API key, OAuth, or token-based) depends on what Zwayam exposes; Truto abstracts this so your end users connect through a single, consistent linking experience. ### Can I access ATS-specific data like candidates, job requisitions, or hiring stages? Zwayam is primarily an ATS, and much of its most valuable data lives in candidate and requisition objects. While Truto's current Unified API coverage for Zwayam is the HRIS Employees endpoint, additional ATS-specific resources can be scoped and built on request as part of the connector buildout. ### How does Truto handle pagination and rate limits for Zwayam? Truto's proxy and unified layers handle pagination automatically — you receive complete result sets without writing cursor or page-tracking logic. Rate-limit back-off and retry strategies are managed server-side by Truto so your integration stays resilient. ### What data can I expect from the Unified HRIS Employees endpoint for Zwayam? The Employees unified model typically includes fields like first name, last name, primary email, phone number, department, employment status, and start date. Exact field coverage depends on what Zwayam's API exposes and is confirmed during the connector build.