webhooks_dyb.md

Webhooks

applicaton.created

Webhook dispatched when an application is added to a board

example :

{
  "id": "9da9a03f-d743-4c91-8e53-1bd52913602d",
  "action": "application.created",
  "date": "2022-12-09T10:16:23+01:00",
  "properties": {
    "application": "id of the application (uuid)",
    "creator": "doyoubuzz id of the creator (string",
    "board": "id of the board (uuid)",
    "state": "id of the state (uuid)"
  }
}

application.state_switched

application.final_state_switched

Webhook dispatched when an application is moved to a different or the final state in a board

example :

{
  "id": "9da9a03f-d743-4c91-8e53-1bd52913602d",
  "action": "application.state_switched or application.final_state_switched",
  "date": "2022-12-09T10:16:23+01:00",
  "properties": {
    "application": "id of the application (uuid)",
    "from": "id of the original state",
    "to": "id of the next state",
    "by": "doyoubuzz id the user that moved the application"
  }
}

cv.created

main_cv.created

Webhook dispatched when a new resume is created (all resumes or only main ones)

example :

{
  "id": "9da9a03f-d743-4c91-8e53-1bd52913602d",
  "action": "cv.created or main_cv.created",
  "date": "2022-12-09T10:16:23+01:00",
  "properties": {
    "cv": "doyoubuzz id of the cv",
    "user": "doyoubuzz id of the user",
    "creator": "doyoubuzz id of the creator",
    "lang": "lang of the new cv",
    "source": "origin of the creation (ex : 'api', 'ui')"
  }
}

cv.updated

main_cv.updated

Webhook dispatched when the content of a (main) resume is updated (using editor)

example :

{
  "id": "9da9a03f-d743-4c91-8e53-1bd52913602d",
  "action": "cv.updated",
  "date": "2022-12-09T10:16:23+01:00",
  "properties": {
    "cv": "doyoubuzz id of the cv",
    "user": "doyoubuzz id of the user",
    "editor": "doyoubuzz id of the editor",
    "lang": "lang of the cv"
  }
}

user.deleted

Webhook dispatched when a user is deleted

example :

{
  "id": "9da9a03f-d743-4c91-8e53-1bd52913602d",
  "action": "user.deleted",
  "date": "2022-12-09T10:16:23+01:00",
  "properties": {
    "user": "doyoubuzz id of the user",
    "kind": "kind of the user ('candidat', 'consultant', 'manager' or 'admin') ",
    "lastname": "lastname of the user",
    "firstname": "firstname of the user",
    "email" : "email of the user"
  }
}

user.created

Webhook dispatched when a user is created

{
  "id": "9da9a03f-d743-4c91-8e53-1bd52913602d",
  "action": "user.created",
  "date": "2022-12-09T10:16:23+01:00",
  "properties": {
    "user": "doyoubuzz id of the user",
    "kind": "kind of the user ('candidat', 'consultant', 'manager' or 'admin') ",
    "creator" : "doyoubuzz id of the creator (optional)"
  }
}

user.end_consent.alerted

Webhook dispatched when a user is alerted about the future deletion of his account (for inactivity or end of consent)

{
  "id": "9da9a03f-d743-4c91-8e53-1bd52913602d",
  "action": "user.end_consent.alerted",
  "date": "2022-12-09T10:16:23+01:00",
  "properties": {
    "user": "doyoubuzz id of the user",
    "last_login": "2012-12-31",
    "consent_limit_date" : "2014-12-31",
    "context": "dyb:users:alert-inactive or dyb:users:alert-end-consent"
  }
}

comment.saved

Webhook dispatched when a comment has been saved / edited

{
  "id": "9da9a03f-d743-4c91-8e53-1bd52913602d",
  "action": "comment.saved",
  "date": "2022-12-09T10:16:23+01:00",
  "properties": {
    "comment": "id of the comment",
    "user": "doyoubuzz id of the user",
    "author" : "doyoubuzz id of the author"
  }
}

availability_removed

Webhook dispatched when we submit the availability form selecting the blank value in the select element

{
  "id": "9da9a03f-d743-4c91-8e53-1bd52913602d",
  "action": "availability_removed",
  "date": "2022-12-09T10:16:23+01:00",
  "properties": {
    "availability": {
      "calculated_interval": "string representing the number of days to wait before the user is available, this value is calculated when the user is available at a fixed date"
      "interval" : "string representing the number of days before the user is available. 'fixed_date' when the user is available at a fixed date. 'now', 'two_weeks', 'one_month', 'two_months', 'three_months' or 'later' when the user is available after an interval of time "
      "date" : "2022-12-09T10:16:23+01:00"
    },
    "user": {
      "showcase_id" : "showcase id of the user",
      "doyoubuzz_id" : "doyoubuzz id of the user"
    }
  }
}

availability_added

Webhook dispatched when we submit the availability form selecting other than the blank value in the select element

{
  "id": "9da9a03f-d743-4c91-8e53-1bd52913602d",
  "action": "availability_removed",
  "date": "2022-12-09T10:16:23+01:00",
  "properties": {
    "availability": {
      "calculated_interval": "string representing the number of days to wait before the user is available, this value is calculated when the user is available at a fixed date"
      "interval" : "string representing the number of days before the user is available. 'fixed_date' when the user is available at a fixed date. 'now', 'two_weeks', 'one_month', 'two_months', 'three_months' or 'later' when the user is available after an interval of time "
      "date" : "2022-12-09T10:16:23+01:00"
    },
    "user": {
      "showcase_id" : "showcase id of the user",
      "doyoubuzz_id" : "doyoubuzz id of the user"
    }
  }
}