You connect OTYS yourself: one ticket with OTYS support for an API user, then you paste the API key into Hyre.
Before you start
You are a key user in OTYS. Only the person who creates the ticket can see and answer it.
You know your OTYS customer number and environment (
[company].otysapp.com).In Hyre anyone can make the connection. An owner or admin chooses the write target.
Step by step
1. Ask OTYS support for an API user
Submit this ticket as key user. OTYS support works in Dutch, so the ticket is in Dutch. Fill in your customer number and environment:
``` Onderwerp: OWS API-gebruiker aanmaken
Beste OTYS support,
Wij willen graag een API gebruiker aanmaken via OWS. Klantnummer: [klantnummer], omgeving: [bedrijf].otysapp.com
Kunnen jullie het volgende voor ons doen: 1. Een aparte API-gebruiker aanmaken, met een OWS API-key. 2. Deze gebruikersinstellingen aanzetten voor die gebruiker: SE77, SE78, SE2757, SE3315 en de CRM-/relatiemodule. 3. Lees- en schrijfrechten op deze Otys.Services: - CandidateService - VacancyService - ProcedureService - RelationService - RelationContactService - NoticeService - ReminderService - CalendarService - TaskService - DocumentTypeService - DossierService - AttachedDocumentsService 4. Toestemming om het veld userId (eigenaar) te zetten bij kandidaten en relatiecontactpersonen.
Stuur de API-key via een veilige weg.
Alvast bedankt! ```
In short, the ticket asks for: a separate API user with an OWS API key; user settings SE77, SE78, SE2757, SE3315 and the CRM/relations module; read and write rights on the twelve services listed; and permission to set the owner field (userId) on candidates and contact persons.
As key user you can also switch on the SE settings yourself: go to Gebruikersinstellingen (user settings), set Type instelling to Gebruiker (user) and pick the API user. Watch out: the screen opens on your own account, so make sure you select the API user.
2. Connect OTYS in Hyre
Go to Settings › Integrations, find OTYS and click Connect.
Paste the API key and confirm.
Does the card say Ask for: with service names? The API user is still missing rights. Request them from OTYS support, then click Re-check access in Hyre.
Owner or admin: make OTYS the write target with ⋯ › Make ATS write target (and Make CRM write target if you keep relations and contact persons in OTYS too).
3. Create the Hyre profile field and set up your recruiters
In OTYS, create an extraInfo field called Hyre profile, at least 2,000 characters long.
In Hyre, click Refresh under Settings › Fields.
Make sure every recruiter signs in to Hyre with the same email address as in OTYS. Notes then land under the recruiter's name.
Good to know
Hyre only writes to OTYS when a recruiter asks: through the actions on a conversation (Run agent), the ATS & CRM sync routine, or a request to your AI assistant.
Notes go into the dossier of the candidate or contact person, under your own OTYS note type that fits the kind of conversation. If no type fits, under "Overige" (other).
Hyre does not write email conversations to OTYS. OTYS already files synced mail in the dossier itself.
Note author. If the API user lacks setting SE3315, or OTYS doesn't know the recruiter, the note still lands, starting with "Logged by
via Hyre".
Fields such as notice period and available from can only be updated if the API user has rights on those fields. Without them the candidate update fails. The card in Hyre then shows what is missing.
CVs: ask your OTYS key user to create a document type CV (setting GE91). Otherwise CVs end up under "Overige".
Remarks field: if you want notes in the remarks field instead of the dossier, know that writing to that field overwrites the whole field. The dossier is safer.
Job title, employer and LinkedIn stay in Hyre.
Hyre doesn't link candidates without a phone number or email address to conversations.
Never send the API key by email, not even to us. You paste it into Hyre yourself.
Read the lesson
Video: Integration in the Hyre Academy, Admin setup chapter (Dutch).
Related