Skip to main content

Webhooks

Flatchr has several webhooks that can be configured for free to communicate with third-party applications when certain events are triggered.

What is a Webhook?​

Simply put, webhooks (or web callbacks / HTTP callbacks) allow you to trigger an action following an event. They are generally used to make systems communicate with each other.
It's the simplest way to receive an alert when something happens in another system.

Flatchr allows you to configure outbound webhooks to notify another application when an action has taken place in the ATS.

Example

When a candidate is placed in the "hired" column in Flatchr, do you want that candidate to be automatically created in your HRIS?
This is possible thanks to a Webhook!


What is the difference between Webhooks and an API?​

Webhooks and the API both use HTTP requests, but their operating principles are slightly different. With an API, you must regularly poll it for new data, whereas webhooks allow the client to receive information without needing to query the server.

This is why webhooks are widely used to send event-triggered information such as a new candidate or a new email received.

Webhooks/API Illustration


How to enable Webhooks in the Flatchr interface?​

To make the Webhook application available on the Marketplaces page, simply click this installation link: enable webhooks.


How to configure Webhooks?​

To configure a Webhook, go to the Administration > Marketplace tab and then click on the Webhooks application.

You will then be asked to configure certain elements:

  • the URL to which the data will be sent
  • the event that will trigger the data transmission
  • the job listing and column concerned may be requested depending on the selected event

The different configurable events​

Below are all the events for which a Webhook can be configured:

New candidate

A Webhook can be created to send a request when a new candidate is created.


NameTypeDescription
datadataObject containing the data
eventstringEvent that triggered the request (here: 'new_applicant')
company_idintegerPlain text company identifier
Example
{
  data: {
    applicant: {
      candidate_id: 1648,
      vacancy_id: '0LEZBvp5WKnMoVmg',
      comment: '',
      column_id: 'a4JL2lpEQKpwBXKe',
      updated_at: 2022-01-13T15:21:22.164Z,
      created_at: 2022-01-13T15:21:22.164Z,
      id: 'G6KzqPkNZ0n31m0l',
      score: 0,
      status: 1,
      comments: null,
      urls: null,
      external_id: null,
      view: false,
      anonym: false,
      duplicate: null,
      reason_id: null,
      column: [Object]
    },
    candidate: {
      firstname: 'Pauline',
      lastname: 'Duboneau',
      email: 'duboneau.p@mail.com',
      urls: [Object],
      phone: '+33654342384',
      updated_at: 2022-01-14T13:55:31.919Z,
      created_at: 2022-01-14T13:55:31.919Z,
      id: 1648,
      status: 1,
      external_id: null,
      summary: null,
      contact_information: null,
      comments: null,
      user_id: null,
      consent: true
    },
    vacancy: {
      id: 1575,
      company_id: 'Vw67MkgKj2dJ1203',
      title: 'Chirurgien',
      description: 'Créé en 1974 au sein de l'AP-HM, le Centre Hospitalier de la Timone est le plus important de la région PACA. Il est considéré par son activité, son équipement de pointe et ses moyens humains comme le troisième hôpital européen.',
      experience: 1,
      salary: '0',
      status: 1,
      contract_type_id: 1,
      activity_id: 35,
      external_id: null,
      created_by: 'lVq5r6pYLD9PmMvP',
      created_at: 2021-10-11T12:29:16.187Z,
      updated_at: 2022-01-13T14:49:27.828Z,
      mission: '<p>Gerer les differentes intervetions pour les patients</p>',
      profile: "<p>Identifier la demande du patient et rechercher les informations complémentaires dans le dossier médical<br>Définir les orientations stratégiques d'une structure<br>Recenser les symptômes, les dysfonctionnements, cerner l'environnement de vie du patient et procéder à l'examen clinique<br>Déterminer les besoins thérapeutiques et réaliser les soins médicaux<br>Réaliser la prescription médicale, expliquer les modalités de traitement au patient et le conseiller sur l'hygiène de vie<br>Repérer les situations à risques (maltraitance, addiction, ...) et orienter le patient vers d'autres professionnels ou informer les services concernés (sociaux, judiciaires, ...)<br>Compléter les documents médico-administratifs (feuille de soins, déclaration de grossesse)<br>Actualiser le dossier médical du patient<br>Représenter une structure lors d'évènements (salons professionnels, ...)<br>Actualiser la documentation professionnelle et réglementaire<br>Participer à des groupes de travail</p>",
      channel_id: 10,
      metier_id: 122,
      daxtra_index: true,
      mensuality: 'y',
      reference: 'chirurgien-2022',
      published: false,
      semantic: false,
      slug: '0lezbvp5wwnmovmg-chirurgien',
      slug_mail: 'dn4y5z',
      driver_license: false,
      education_level_id: 1,
      start_date: null,
      end_date: null,
      apply_url: null,
      updated_by: null,
      language: 'fr_FR',
      meta_tags: null,
      meta_description: null,
      meta_title: null,
      options: null,
      remote: "notime",
      kanban: true,
      note: '<p></p>',
      currency: 'EUR',
      partial: false,
      handicap: false,
      questions: [],
      address: [Object]
    },
    column: 643,
    cv: null,
    user: {},
    message: 'Un nouveau candidat a postulé sur votre offre <b>Chirurgien</b>',
    applicant_id: 1860,
    candidate_id: 1648,
    column_id: 'a4JL2lpEQKpwBXKe',
    vacancy_id: '0LEZBvp5WWnMoVmg',
    company: { id: 'Vw67MknKj2dJ1203', name: 'Hopital de la Timone' }
  },
  event: 'new_applicant',
  company_id: 59
}
Candidate moved

A Webhook can be created to send a request when a candidate is moved to a defined column. The Webhook can be configured to transfer the information of a hired candidate to an ATS.


NameTypeDescription
datadataObject containing the data
eventstringEvent that triggered the request (here: 'drag_applicant')
company_idintegerPlain text company identifier
Example
{
  data: {
    user: {
      email: 'tom_bourgis@gmail.com',
      status: 1,
      id: 240,
      firstname: 'Tom',
      lastname: 'Bourgis',
      phone: null,
      company: 'L'entreprise',
      language: 'fr_FR',
      last_login: 2022-01-13T15:12:14.899Z,
      created_at: 2019-03-21T09:24:02.375Z,
      updated_at: 2022-01-13T15:12:14.901Z,
      signature: '<p>Tom Bourgis</p>\n' +
        '<p>Chargé de développement</p>\n' +
        '<p>+33 (0)6 20 51 96 08 - tom.bourgis@lentreprise.io</p>\n' +
        '<p><a href="https://app.hubspot.com/meetings/tom-3" target="_blank">Prendre un rendez-vous</a>&nbsp;</p>\n' +
        '<p></p>\n',
      use_email: false,
      timezone: 'Europe/Paris',
      gmail_last_sync_id: null,
      gmail_last_sync_date: null,
      picture: [Object]
    },
    applicant: {
      id: 1474,
      vacancy_id: 'a4JL2lpEbydwBXKe',
      candidate_id: 1260,
      score: 0,
      status: 1,
      created_at: 2022-01-13T15:21:22.164Z,
      updated_at: 2022-01-13T15:26:53.148Z,
      comment: null,
      column_id: 'Nk5aMxpQ4b9GZ2Oz',
      comments: null,
      urls: null,
      external_id: null,
      view: false,
      anonym: false,
      duplicate: null,
      reason_id: null,
      applies: [Array],
      column: [Object],
      vacancy: [Object]
    },
    candidate: {
      id: 1260,
      firstname: 'Hubert',
      lastname: 'Delajaque',
      email: 'delajaque@mail.com',
      status: 1,
      external_id: null,
      created_at: 2022-01-13T15:21:22.063Z,
      updated_at: 2022-01-13T15:21:22.116Z,
      summary: null,
      contact_information: null,
      comments: null,
      urls: {},
      user_id: null,
      phone: '+33 6 76 56 45 23',
      consent: true,
      cv: {},
      additionals: [Object]
    },
    column: {
      id: 695,
      title: 'Pré-qualification RH',
      company_id: 'G6KzqPnNLyp31m0l',
      position: 2,
      created_at: 2019-12-12T12:34:15.174Z,
      updated_at: 2021-11-05T09:12:15.563Z,
      visible: true,
      hired: false
    },
    vacancy: {
      id: 1243,
      company_id: 'G6KzqPnNLyp31m0l',
      title: 'Account Executive ',
      description: '<div>Quid? qui se etiam nunc subsidiis patrimonii aut amicorum liberalitate sustentant, hos perire patiemur? An, si qui frui publico non potuit per hostem, hic tegitur ipsa lege censoria; quem is frui non sinit, qui est, etiamsi non appellatur, hostis, huic ferri auxilium non oportet? Retinete igitur in provincia diutius eum, qui de sociis cum hostibus, de civibus cum sociis faciat pactiones, qui hoc etiam se pluris esse quam collegam putet, quod ille vos tristia voltuque deceperit, ipse numquam se minus quam erat, nequam esse simularit. Piso autem alio quodam modo gloriatur se brevi tempore perfecisse, ne Gabinius unus omnium nequissimus existimaretur.</div>',
      experience: 2,
      salary: '0',
      status: 1,
      contract_type_id: 5,
      activity_id: 13,
      external_id: null,
      created_by: 'LrENkKp8lZd3xYGM',
      created_at: 2020-12-01T14:14:28.005Z,
      updated_at: 2021-12-28T16:39:01.848Z,
      mission: '<div>Prospecte une clientèle de professionnels, propose des solutions techniques selon les besoins, impératifs du client et négocie les conditions commerciales de la vente.<br>Peut coordonner une équipe commerciale et animer un réseau de commerciaux.</div>',
      profile: "<div>Définir le plan d'action commercial et établir le plan de tournée (ciblage, interlocuteurs, préparation de dossiers techniques)<br>Concevoir une étude de faisabilité technique<br>Établir un devis<br>Négocier un contrat<br>Établir un contrat de vente<br>Vérifier les conditions de réalisation d'une commande<br>Suivre la réalisation d'une prestation technique<br>Analyser les résultats des ventes<br>Déterminer des mesures correctives</div>",
      channel_id: 2,
      metier_id: 54,
      daxtra_index: true,
      mensuality: 'y',
      reference: 'Account Executive',
      published: false,
      semantic: false,
      slug: 'a4jl2lpebydwbxme-commercial-btob-h-f',
      slug_mail: 'dj3q2z',
      driver_license: true,
      education_level_id: 5,
      start_date: null,
      end_date: null,
      apply_url: null,
      updated_by: null,
      language: 'fr_FR',
      meta_tags: null,
      meta_description: null,
      meta_title: null,
      options: [Object],
      remote: "fulltime",
      kanban: true,
      note: '',
      currency: 'EUR',
      partial: false,
      handicap: false
    },
    user_id: '0D3NVZdqe7dMyb6z',
    applicant_id: 1474,
    candidate_id: 1260,
    column_id: 'Nk5aMxpQ4b9GZ2Oz',
    vacancy_id: 'a4JL2lpEbydwBXKe',
    company: { id: 'G6KzqPnNLyp31m0l', name: "L'entreprise" }
  },
  event: 'drag_applicant',
  company_id: 60
}
File added to a candidate's profile

A Webhook can be created to send a request when a file is added to a candidate's profile. The Webhook can be configured to transfer the file information to the URL of your choice.


NameTypeDescription
datadataObject containing the data
eventstringEvent that triggered the request (here: 'upload_file')
company_idintegerPlain text company identifier
Example
{
  "company_id": "xWy3EOp2y291KMq8",
  "vacancy_id": "zNDRr9BxE2dYqQyE",
  "applicant_id": "8AbY1n7OqenLgJNk",
  "media": {
    "candidate_id": "4JL2lpEYVMpwBXKe",
    "vacancy_id": "zNDRr9BxE2dYqQyE",
    "company_id": "xWy3EOp2y291KMq8",
    "text": "chat.jpg",
    "created_by": "M4Bely9PB3dkEKR6",
    "updated_at": "2026-04-09T09:26:15.386Z",
    "created_at": "2026-04-09T09:26:15.386Z",
    "id": "z5QorW9wEYdyelRq",
    "deleted_at": null,
    "attachment": {
      "key": "medias/z5QorW9wEYdyelRq/chat.jpg",
      "url": "flatchr-development.s3.eu-west-1.amazonaws.com/medias/z5QorW9wEYdyelRq/chat.jpg",
      "filename": "chat.jpg",
      "attacheable_id": "z5QorW9wEYdyelRq",
      "attacheable_type": "medias",
      "updated_at": "2026-04-09T09:26:15.639Z",
      "created_at": "2026-04-09T09:26:15.639Z",
      "id": "jKJ0MpzP2XnXNgxa",
      "deleted_at": null
    },
    "author": {
      "id": "M4Bely9PB3dkEKR6",
      "firstname": "Admin",
      "lastname": "Career",
      "email": "career-a@flatchr.io",
      "phone": "+33 1 23 45 67 89",
      "company": "Pinguin Limited",
      "status": 1,
      "language": "fr_FR",
      "last_login": "2026-03-26T16:36:10.756Z",
      "created_at": "2023-03-20T14:48:22.297Z",
      "updated_at": "2026-03-26T16:36:10.757Z",
      "use_email": false,
      "timezone": "Europe/Paris",
      "gmail_last_sync_id": null,
      "gmail_last_sync_date": null,
      "consent": true,
      "consent_date": "2023-03-20T14:59:22.380Z",
      "calendar": "https://calendar.google.com/xlsjdu",
      "job_title": "Admin",
      "picture": {
        "id": 459,
        "url": "flatchr-demo.s3.eu-west-1.amazonaws.com/users/pictures/user_M4Bely9PB3dkEKR6.jpeg",
        "imageable_id": 619,
        "imageable_type": "users",
        "created_at": "2024-07-23T09:24:16.188Z",
        "updated_at": "2024-07-23T09:24:16.188Z"
      }
    }
  },
  "vacancy": null,
  "company": {
    "id": "xWy3EOp2y291KMq8",
    "name": "Pro & Cie",
    "datas": [
      {
        "app_value": "https://webhook.site/a51b22f5-110a-413c-bb7e-bf8df39dc1cb"
      }
    ]
  },
  "event": "upload_file"
}