{"_id":"5bd329bf652d84000d2b6eed","project":"54ee19c23749bf0d00c76515","version":{"_id":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","__v":2,"createdAt":"2018-01-18T19:32:29.915Z","releaseDate":"2018-01-18T19:32:29.915Z","categories":["5a60f64d792a330012d72141","5a60f64d792a330012d72142","5a60f64d792a330012d72143","5a60f64d792a330012d72144","5a60f64d792a330012d72145","5a60f64d792a330012d72146","5a60f64d792a330012d72147","5a660cc7dc0f1c001c2b5568"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"5a60f64d792a330012d72141","version":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-02-25T23:49:16.381Z","from_sync":false,"order":0,"slug":"overview","title":"Overview"},"user":"575f003663430e0e008a8704","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-10-26T14:50:39.165Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":999,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Webhook functionality is currently available for Pro plans. Please contact [support:::at:::breezyhr.com](mailto:support@breezyhr.com) for details and available options.\"\n}\n[/block]\nBelow are the current actions that Breezy currently provides webhooks for. If you have a request for new actions, please contact [support@breezyhr.com](mailto:support@breezyhr.com) \n[block:api-header]\n{\n  \"title\": \"Candidate Added\"\n}\n[/block]\nThis 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.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"_id\\\" : String,\\n    \\\"type\\\" : \\\"candidateAdded\\\",\\n    \\\"object\\\" : {\\n        \\\"company\\\" : {\\n            \\\"_id\\\" : String,\\n            \\\"name\\\" : String,\\n            \\\"friendly_id\\\" : String,\\n        },\\n        \\\"position\\\" : {\\n            \\\"_id\\\" : String,\\n            \\\"name\\\" : String,\\n            \\\"location\\\" : {\\n                \\\"name\\\" : String\\n            },\\n        },                \\n        \\\"stage\\\" : {\\n            \\\"id\\\" : String,\\n            \\\"name\\\" : String\\n        },\\n        \\\"entered_stage\\\" : Date,\\n        \\\"candidate\\\" : {\\n            \\\"_id\\\" : String,\\n            \\\"name\\\" : String,\\n            \\\"email_address\\\" : String,\\n            \\\"phone_number\\\" : String,\\n            \\\"profile_photo_url\\\" : String,\\n        },\\n        \\\"acting_user\\\" : {\\n            \\\"_id\\\" : String,\\n            \\\"email_address\\\" : String,\\n            \\\"name\\\" : String\\n        },\\n        \\\"source\\\":{\\n          \\\"type\\\": String,\\n          \\\"id\\\": String,\\n          \\\"name\\\": String\\n        }\\n    },\\n    \\\"creation_date\\\" : Date\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Candidate Status Updated\"\n}\n[/block]\nThis 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.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"_id\\\" : String,\\n    \\\"type\\\" : \\\"candidateStatusUpdated\\\",\\n    \\\"object\\\" : {\\n        \\\"company\\\" : {\\n            \\\"_id\\\" : String,\\n            \\\"name\\\" : String,\\n            \\\"friendly_id\\\" : String,\\n        },\\n        \\\"position\\\" : {\\n            \\\"_id\\\" : String,\\n            \\\"name\\\" : String,\\n            \\\"location\\\" : {\\n                \\\"name\\\" : String\\n            },\\n        },\\n        \\\"stage_was\\\" : {\\n            \\\"id\\\" : String,\\n            \\\"name\\\" : String\\n        },\\n        \\\"entered_previous_stage\\\" : Date,\\n        \\\"stage\\\" : {\\n            \\\"id\\\" : String,\\n            \\\"name\\\" : String\\n        },\\n        \\\"entered_stage\\\" : Date,\\n        \\\"candidate\\\" : {\\n            \\\"_id\\\" : String,\\n            \\\"name\\\" : String,\\n            \\\"email_address\\\" : String,\\n            \\\"phone_number\\\" : String,\\n            \\\"profile_photo_url\\\" : String,\\n        },\\n        \\\"acting_user\\\" : {\\n            \\\"_id\\\" : String,\\n            \\\"email_address\\\" : String,\\n            \\\"name\\\" : String\\n        },\\n        \\\"time_in_previous_stage\\\" : Number,\\n    },\\n    \\\"creation_date\\\" : Date\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"webhooks","type":"basic","title":"Webhooks"}
[block:callout] { "type": "info", "body": "Webhook functionality is currently available for Pro plans. Please contact [support@breezyhr.com](mailto:support@breezyhr.com) for details and available options." } [/block] Below are the current actions that Breezy currently provides webhooks for. If you have a request for new actions, please contact [support@breezyhr.com](mailto:support@breezyhr.com) [block:api-header] { "title": "Candidate Added" } [/block] 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. [block:code] { "codes": [ { "code": "{\n \"_id\" : String,\n \"type\" : \"candidateAdded\",\n \"object\" : {\n \"company\" : {\n \"_id\" : String,\n \"name\" : String,\n \"friendly_id\" : String,\n },\n \"position\" : {\n \"_id\" : String,\n \"name\" : String,\n \"location\" : {\n \"name\" : String\n },\n }, \n \"stage\" : {\n \"id\" : String,\n \"name\" : String\n },\n \"entered_stage\" : Date,\n \"candidate\" : {\n \"_id\" : String,\n \"name\" : String,\n \"email_address\" : String,\n \"phone_number\" : String,\n \"profile_photo_url\" : String,\n },\n \"acting_user\" : {\n \"_id\" : String,\n \"email_address\" : String,\n \"name\" : String\n },\n \"source\":{\n \"type\": String,\n \"id\": String,\n \"name\": String\n }\n },\n \"creation_date\" : Date\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Candidate Status Updated" } [/block] 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. [block:code] { "codes": [ { "code": "{\n \"_id\" : String,\n \"type\" : \"candidateStatusUpdated\",\n \"object\" : {\n \"company\" : {\n \"_id\" : String,\n \"name\" : String,\n \"friendly_id\" : String,\n },\n \"position\" : {\n \"_id\" : String,\n \"name\" : String,\n \"location\" : {\n \"name\" : String\n },\n },\n \"stage_was\" : {\n \"id\" : String,\n \"name\" : String\n },\n \"entered_previous_stage\" : Date,\n \"stage\" : {\n \"id\" : String,\n \"name\" : String\n },\n \"entered_stage\" : Date,\n \"candidate\" : {\n \"_id\" : String,\n \"name\" : String,\n \"email_address\" : String,\n \"phone_number\" : String,\n \"profile_photo_url\" : String,\n },\n \"acting_user\" : {\n \"_id\" : String,\n \"email_address\" : String,\n \"name\" : String\n },\n \"time_in_previous_stage\" : Number,\n },\n \"creation_date\" : Date\n}", "language": "json" } ] } [/block]