Webhook Events

Below are all webhook events that Breezy provides. Each event is delivered as a POST request to your configured endpoint with a JSON payload.

All webhook payloads follow this envelope structure:

{
    "_id" : String,
    "type" : String,
    "object" : { ... },
    "creation_date" : Date
}

Candidate Added

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

{
    "_id" : String,
    "type" : "candidateAdded",
    "object" : {
        "company" : {
            "_id" : String,
            "name" : String,
            "friendly_id" : String
        },
        "position" : {
            "_id" : String,
            "name" : String,
            "pipeline_id" : String,
            "all_admins" : Boolean,
            "location" : {
                "name" : String
            }
        },
        "stage" : {
            "id" : String,
            "name" : String
        },
        "entered_stage" : Date,
        "candidate" : {
            "_id" : String,
            "name" : String,
            "email_address" : String,
            "phone_number" : String,
            "profile_photo_url" : String,
            "tags" : Array
        },
        "acting_user" : {
            "_id" : String,
            "email_address" : String,
            "name" : String,
            "profile_photo_url" : 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.

{
    "_id" : String,
    "type" : "candidateDeleted",
    "object" : {
        "company" : {
            "_id" : String,
            "name" : String,
            "friendly_id" : String
        },
        "position" : {
            "_id" : String,
            "name" : String,
            "pipeline_id" : String,
            "all_admins" : Boolean,
            "location" : {
                "name" : String
            }
        },
        "candidate" : {
            "_id" : String,
            "name" : String,
            "email_address" : String,
            "phone_number" : String,
            "profile_photo_url" : String,
            "tags" : Array
        },
        "acting_user" : {
            "_id" : String,
            "email_address" : String,
            "name" : String,
            "profile_photo_url" : 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 first enters the system.

{
    "_id" : String,
    "type" : "candidateStatusUpdated",
    "object" : {
        "company" : {
            "_id" : String,
            "name" : String,
            "friendly_id" : String
        },
        "position" : {
            "_id" : String,
            "name" : String,
            "pipeline_id" : String,
            "all_admins" : Boolean,
            "location" : {
                "name" : String
            }
        },
        "stage_was" : {
            "id" : String,
            "name" : String
        },
        "entered_previous_stage" : Date,
        "stage" : {
            "id" : String,
            "name" : String
        },
        "entered_stage" : Date,
        "time_in_previous_stage" : Number,
        "candidate" : {
            "_id" : String,
            "name" : String,
            "email_address" : String,
            "phone_number" : String,
            "profile_photo_url" : String,
            "tags" : Array
        },
        "acting_user" : {
            "_id" : String,
            "email_address" : String,
            "name" : String,
            "profile_photo_url" : String
        },
        "source" : {
            "type" : String,
            "id" : String,
            "name" : String
        },
        "external_source" : {
            "id" : String,
            "name" : String
        }
    },
    "creation_date" : Date
}

Position Added

This webhook is fired when a new position is created in the company.

{
    "_id" : String,
    "type" : "companyPositionAdded",
    "object" : {
        "company" : {
            "_id" : String,
            "name" : String,
            "friendly_id" : String
        },
        "position" : {
            "_id" : String,
            "name" : String,
            "friendly_id" : String,
            "state" : String,
            "type" : String,
            "location" : {
                "name" : String,
                "city" : String,
                "state" : String,
                "country" : String
            },
            "department" : String
        },
        "acting_user" : {
            "_id" : String,
            "email_address" : String,
            "name" : String,
            "profile_photo_url" : String
        }
    },
    "creation_date" : Date
}

Position Updated

This webhook is fired when a position's details are updated (name, description, requirements, etc.). This does not fire when the position state changes - see Position State Updated for that event.

{
    "_id" : String,
    "type" : "companyPositionUpdated",
    "object" : {
        "company" : {
            "_id" : String,
            "name" : String,
            "friendly_id" : String
        },
        "position" : {
            "_id" : String,
            "name" : String,
            "friendly_id" : String,
            "state" : String,
            "type" : String,
            "location" : {
                "name" : String,
                "city" : String,
                "state" : String,
                "country" : String
            },
            "department" : String
        },
        "acting_user" : {
            "_id" : String,
            "email_address" : String,
            "name" : String,
            "profile_photo_url" : String
        }
    },
    "creation_date" : Date
}

Position Deleted

This webhook is fired when a position is deleted from the company.

{
    "_id" : String,
    "type" : "companyPositionDeleted",
    "object" : {
        "company" : {
            "_id" : String,
            "name" : String,
            "friendly_id" : String
        },
        "position" : {
            "_id" : String,
            "name" : String,
            "friendly_id" : String,
            "state" : String,
            "type" : String,
            "location" : {
                "name" : String,
                "city" : String,
                "state" : String,
                "country" : String
            },
            "department" : String
        },
        "acting_user" : {
            "_id" : String,
            "email_address" : String,
            "name" : String,
            "profile_photo_url" : String
        }
    },
    "creation_date" : Date
}

Position State Updated

This webhook is fired when a position's state changes (e.g., from draft to published, or published to closed).

{
    "_id" : String,
    "type" : "companyPositionStateUpdated",
    "object" : {
        "company" : {
            "_id" : String,
            "name" : String,
            "friendly_id" : String
        },
        "position" : {
            "_id" : String,
            "name" : String,
            "friendly_id" : String,
            "state" : String,
            "type" : String,
            "location" : {
                "name" : String,
                "city" : String,
                "state" : String,
                "country" : String
            },
            "department" : String
        },
        "acting_user" : {
            "_id" : String,
            "email_address" : String,
            "name" : String,
            "profile_photo_url" : String
        },
        "state_is" : String,
        "state_was" : String
    },
    "creation_date" : Date
}

Team Note Posted

This webhook is fired when a team member posts a note in the candidate's team discussion.

{
    "_id" : String,
    "type" : "companyNotePosted",
    "object" : {
        "company_id" : String,
        "position" : {
            "_id" : String,
            "name" : String,
            "pipeline_id" : String,
            "all_admins" : Boolean,
            "location" : {
                "name" : String
            }
        },
        "candidate" : {
            "_id" : String,
            "name" : String,
            "email_address" : String,
            "phone_number" : String,
            "profile_photo_url" : String,
            "tags" : Array
        },
        "acting_user" : {
            "_id" : String,
            "email_address" : String,
            "name" : String,
            "profile_photo_url" : String
        },
        "body" : String,
        "attachments" : Array
    },
    "creation_date" : Date
}

Team Note Updated

This webhook is fired when a team discussion note is edited.

{
    "_id" : String,
    "type" : "companyNoteUpdated",
    "object" : {
        "note_id" : String,
        "company_id" : String,
        "position" : {
            "_id" : String,
            "name" : String,
            "pipeline_id" : String,
            "all_admins" : Boolean,
            "location" : {
                "name" : String
            }
        },
        "candidate" : {
            "_id" : String,
            "name" : String,
            "email_address" : String,
            "phone_number" : String,
            "profile_photo_url" : String,
            "tags" : Array
        },
        "acting_user" : {
            "_id" : String,
            "email_address" : String,
            "name" : String,
            "profile_photo_url" : String
        },
        "body" : String,
        "attachments" : Array
    },
    "creation_date" : Date
}

Team Note Deleted

This webhook is fired when a team discussion note is deleted.

{
    "_id" : String,
    "type" : "companyNoteDeleted",
    "object" : {
        "note_id" : String,
        "company_id" : String,
        "acting_user" : {
            "_id" : String,
            "email_address" : String,
            "name" : String,
            "profile_photo_url" : String
        }
    },
    "creation_date" : Date
}

elow are all webhook events that Breezy provides. Each event is delivered as a POST request to your configured endpoint with a JSON payload.