Webhooks

📘
Webhook functionality is currently available for Pro plans. Please contact [email protected] for details and available options.

Below are the current actions that Breezy currently provides webhooks for. If you have a request for new actions, please contact [email protected]

Candidate Added

This webhook is fired when a candidate enters the system. Candidates can enter the system by applying, being sourced, being recruited, being referred. Example payload below.

{
    "_id" : String,
    "type" : "candidateAdded",
    "object" : {
        "company" : {
            "_id" : String,
            "name" : String,
            "friendly_id" : String,
        },
        "position" : {
            "_id" : String,
            "name" : String,
            "location" : {
                "name" : String
            },
        },                
        "stage" : {
            "id" : String or Number,
            "name" : String
        },
        "entered_stage" : Date,
        "candidate" : {
            "_id" : String,
            "name" : String,
            "email_address" : String,
            "phone_number" : String,
            "profile_photo_url" : String,
        },
        "acting_user" : {
            "_id" : String,
            "email_address" : String,
            "name" : String
        },
        "source":{
          "type": String,
          "id": String,
          "name": String
        },
      	"external_source":{
          "id": String,
          "name": String
        }
    },
    "creation_date" : Date
}

Candidate Deleted

This webhook is fired when a candidate is deleted using the web application. Please note this event is not fired when a candidate is purged via auto-delete configured with GDPR settings enabled. Example payload below.

{
    "_id" : String,
    "type" : "candidateDeleted",
    "object" : {
        "company" : {
            "_id" : String,
            "name" : String,
            "friendly_id" : String,
        },
        "position" : {
            "_id" : String,
            "name" : String,
            "location" : {
                "name" : String
            },
        },        
        "candidate" : {
            "_id" : String,
            "name" : String,
            "email_address" : String,
            "phone_number" : String,
            "profile_photo_url" : String,
        },
        "acting_user" : {
            "_id" : String,
            "email_address" : String,
            "name" : String
        }
    },
    "creation_date" : Date
}

Candidate Status Updated

This webhook is fired when a candidate moves from one stage in a pipeline to another. Please note this event is not fired when a candidate enters the system. Example payload below.

{
    "_id" : String,
    "type" : "candidateStatusUpdated",
    "object" : {
        "company" : {
            "_id" : String,
            "name" : String,
            "friendly_id" : String,
        },
        "position" : {
            "_id" : String,
            "name" : String,
            "location" : {
                "name" : String
            },
        },
        "stage_was" : {
            "id" : String or Number,
            "name" : String
        },
        "entered_previous_stage" : Date,
        "stage" : {
            "id" : String or Number,
            "name" : String
        },
        "entered_stage" : Date,
        "candidate" : {
            "_id" : String,
            "name" : String,
            "email_address" : String,
            "phone_number" : String,
            "profile_photo_url" : String,
        },
        "acting_user" : {
            "_id" : String,
            "email_address" : String,
            "name" : String
        },
        "time_in_previous_stage" : Number,
    },
    "creation_date" : Date
}