Référence de l'API partenaires

Base : https://api.omogen.ai/api/v1/integration-partner. Chaque appel porte Authorization: Bearer <clé API> et OM-PARTNER: <clé partenaire>. Si plusieurs intégrations partagent les mêmes clés (configuration posée par Omogen), ajoutez aussi X-Agency-ID.

La spec est téléchargeable en JSON ou en YAML.

Endpoints

Sync an Application

Sync a CV-only Application

List Jobs

Sync a Job Offer

Get Interview Params

Webhooks

Le bloc Request décrit ce qu'Omogen vous envoie, le bloc Response ce que votre URL doit renvoyer (un 2xx suffit).

report_generated

process_rejected

call_booked

Codes d'erreur

Toutes les erreurs ont la même forme :

{ "success": false, "error": "Message lisible", "code": "CODE_MACHINE" }

Code	HTTP	Cause
AUTHENTICATION_FAILED	401	Clé API ou clé partenaire invalide
INVALID_PAYLOAD	400	Champ ou paramètre manquant, mal formé
VALIDATION_ERROR	400	Règle métier non respectée
JOB_OPPORTUNITY_NOT_FOUND	400	job_opportunity_id inconnu de votre organisation
JOB_DETAILS_REQUIRED	400	Offre inconnue, sans description ni mode pull
UNKNOWN_ENRICHMENT_VARIABLE	400	Clé d'enrichment_data non déclarée
CV_DOWNLOAD_FAILED, CV_DECODE_FAILED, CV_TOO_LARGE	400	CV illisible, base64 invalide ou plus de 10 Mo
JOB_FETCH_*	400, 502	Échec du mode pull, voir Pull
INTERNAL_ERROR	500	Erreur inattendue côté Omogen

POST /applications/cv-only ajoute ses codes CV_* d'extraction, décrits dans sa référence.

Champs candidat personnalisés

enrichment_data transmet des valeurs propres à un candidat. L'agent les utilise pendant l'appel, et vos messages SMS, email ou WhatsApp les affichent avec {candidate_<nom>}.

"enrichment_data": {
  "date_candidature": "le 14 mars",
  "lien_inscription": "https://votre-ats.com/inscription/CAND-789"
}

Règle	Détail
Clés déclarées	Chaque clé doit exister comme variable candidat dans Omogen, sinon 400 UNKNOWN_ENRICHMENT_VARIABLE
Valeurs lues à l'oral	Des chaînes : "le 14 mars", pas "2026-03-14"
Mise à jour	Un nouvel envoi pour le même external_candidate_id fusionne les clés ; "" vide une clé