Le principe du webhook est de permettre à un jobboard de notifier Beetween chaque fois qu’il traite une annonce lue dans le flux XML partagé par Beetween.
Appel
Endpoint
L’appel du webhook se fait par une requête POST sur cette url :
https://api.beetween.com/WeaselWeb/xe/webhook/multiposting
Header
| Paramètres | Description | |
| X-API-Key | Requis |
Clé d’api qui identifie l’appelant et nous permet d’authentifier le job board. Ce token sera fourni par Beetween.
|
Body
|
Paramètres |
Description |
|
|
ref |
Requis |
La référence Beetween de l’annonce qui se trouve dans la balise <reference> du flux XML |
|
status |
Requis |
Le statut de l’offre qui sera traité côté Beetween. Les différentes valeurs possibles sont :
|
|
url |
Requis pour les statuts created et updated |
L’url de l’offre d’emploi en ligne sur le job board pour les status created et updated |
|
message |
Requis pour les statuts rejected_commercial, rejected_technical et rejected_job |
Précisions sur les raisons du refus de l’offre. Dans le cas d’un rejet technique, ce message contiendra l’id de l’erreur ou toute autre information pertinente à transmettre au job board pour investigation. |
Exemple de requête:
curl -X POST \
-H "Content-Type: application/json" \
-H "X-API-Key: <api-key>" \
-d '{"ref": "wzx86w29ei","status": "created","url": "https://between.com/hi-there"}'
Retour
Succès
En cas de succès, nous envoyons une réponse avec un statut 200 et le JSON suivant :
{
“status”:”OK”,
“message”:”The offer status has been updated”
}
Échec
En cas d’échec, nous envoyons une réponse avec un statut 400/401/403 et la raison de cet échec se trouvera au niveau de la clé “message” dans la réponse :
{
“status”:”KO”,
“message”:”<Error description>”
}