Generic webhook – Beetween

The principle of the webhook is to allow a job board to notify Beetween each time it processes an advert read in the XML feed shared by Beetween.

Api Call

Endpoint


The webhook is called by a POST request to this url :

https://api.beetween.com/WeaselWeb/xe/webhook/multiposting

Header

Params   Description
X-API-Key Required
  API key that identifies the caller and allows us to authenticate the job board. This token will be supplied by Beetween.

 

Body

Params

 

Description

ref

Required

The Beetween reference for the job offer in the <reference> tag of the XML feed

status

Required

The status of the offer that will be processed by Beetween. The different possible values are :

  • created → The offer is online
  • updated → The offer has been updated
  • deleted → The offer has been withdrawn
  • rejected_commercial → The offer was refused for commercial reasons (no more credit, expired contract, etc.).
  • rejected_technical → The offer was rejected for technical reasons by the job board
  • rejected_job → The offer has been rejected because there is a problem with the advert (advert title, location problem, etc.).

url

Required for created et updated status

The url of the online job offer on the job board for status created and updated

message

Required for rejected_commercial, rejected_technical et rejected_job status

Details of the reasons why the offer was rejected.

In the case of a technical rejection, this message will contain the error id or any other relevant information to be sent to the job board for investigation.

Example of a request:

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"}'

Response

Success

If successful, we send a response with a status of 200 and the following JSON:

{

   “status”:”OK”,

   “message”:”The offer status has been updated”

}

Failure

In the event of failure, we will send a response with a status of 400/401/403 and the reason for this failure will be found in the ‘message’ key in the response:

{

   “status”:”KO”,

   “message”:”<Error description>”

}