Introduction

This guide is designed for our partners and customers who wish to set up a webhook endpoint to receive applications from our system. By integrating with our webhook, you'll be able to automatically receive applications directly to your specified endpoint.

Requirements

Before you begin, ensure you have:

• A server capable of receiving HTTPS POST requests.
• The ability to configure and deploy web services on your server.
• An SSL certificate installed on your server (for secure HTTPS communication).

Setting Up Your Webhook Endpoint

Step 1: Create Your Endpoint

Your webhook endpoint should be a specific URL on your server designed to handle POST requests. This endpoint will listen for incoming requests from our iPaaS and process the data accordingly.

Step 2: Secure Your Endpoint (recommended but optional)

Ensure your endpoint is secured using HTTPS to protect the data in transit. We recommend implementing additional security measures such as IP whitelisting and authentication tokens to further secure the communication.

Step 3: Accepting Payloads

Our iPaaS will send data payloads to your endpoint in a specific format. Your endpoint must be configured to accept and parse JSON payloads. Here is an example of the payload format:

{
  "id": 12345,
  "jobId": "string",
  "candidate": {
    "civility": "MISS",
    "firstName": "John",
    "lastName": "DOE",
    "email": "[email protected]",
    "phoneNumber": "+33123456789",
    "location": {
      "raw": "14 rue Gaillon, 75009 Paris",
      "city": "Paris",
      "zipCode": "75009",
      "country": "France"
     }
  },
  "attachments": [
    {
      "type": "resume", //Possible values: resume, letter
      "contentType": "application/pdf", // Accepted Types: pdf, doc, docx
      "content": "Q2xldmVyY29ubmVjdCByb2Nrcw==", // Content in the base64 Format
      "fileName": "resume.pdf"
    }
  ],
  "origin": "meteojob"
}

Additional explanation for each property

Step 4: Responding to the Webhook