Partner API

Webhooks

webhooks are http requests that the jobylon uses to notify your service of events related to your integration each webhook comes with a payload indicating the event type, action and data relevant to the event in question { "event type" "\<event type>", "action" "\<event action>", "data" { } } event types there are 3 types of webhooks sent by jobylon to the configured partner endpoint event type description company company related event job job related event candidate candidate related event actions each webhook contains one of the following actions actions description new new object created update object was updated (currently only job settings support this) signup company enabled the integration expected response each webhook expects one of the following responses status description 2xx success 4xx 6xx something went wrong if the request is not successful, jobylon will retry sending the request 3 more times, after 10 seconds, 100 seconds and 1000 seconds { "event type" "company", "action" "signup", "data" { "company id" "04b9171e 6d74 451f a8e3 9bc3cf2b2954", "internal id" 23, "company name" "wayne enterprises", "has config" true, "dt created" "2023 06 16 10 40 32", "settings" { "token" "jb k123" } } } name type description company id string company id internal id integer jobylon company internal identifier company name string company name has config boolean partner created a company config dt created datetime integration enabled time settings object company custom fields choices { "event type" "job", "action" "new", "data" { "company" { "id" "04b9171e 6d74 451f a8e3 9bc3cf2b2954", "internal id" 23, "settings" { "token" "jb k123" } }, "job" { "id" "edc3d60e 53d3 4f54 8062 44e4139a52e9", "internal id" 4356, "title" "superhero", "from date" "2022 09 26", "to date" "2023 10 31", "description" "we are seeking an exceptional individual to join our team as a superhero as a superhero, you will be responsible for protecting the innocent, fighting crime, and maintaining peace and justice in our city this is a unique opportunity to use your extraordinary abilities and make a real difference in the lives of our community members ", "skills" "fast driver\nstealth and infiltration\nmaster of disguise", "locations" \[ { "location" "gotham, usa", "location json" { "city" "gotham", &#x9; "city short" "gt", &#x9; "country" "united states of america", &#x9; "country short" "us", &#x9; "area 1" "gotham county", &#x9; "area 1 short" "gotham county" } } ], "requisition" { "internal id" 123, "external id" "jb k123", "identifier" "jb k123", "title" "superhero" }, "experience" "minimum of 5 years fihgting the crime", "language" "en", "ad url" "https //jobylon com/jobs/3 super hero/", "settings" { "notes" "", "deadline" "2023 12 31", "requester" "peter parker", "notifybysms" "yes" } } } } company name type description id string company id internal id integer jobylon company internal identifier settings object company custom fields choices job name type description id string job id internal id integer jobylon job internal identifier title string job title from date date job publish date (job becomes publicly visible) to date date job closing date (job becomes hidden) description string job description skills string job skills locations object job locations experience string job required experience language string job language (alpha 2) ad url url job application url settings object vendor company configurations locations name type description location string location string location json object location details location json name type description city string city name city short string city short name (defaults to city) country string country name country short string country code (alpha 2) area 1 string name of city area area 1 short string short name of city area (defaults to area 1) requisition name type description internal id integer jobylon requisition internal identifier external id string requisition external id from the provider identifier string requisition identifier from the provider title string requisition title request payload { "event type" "candidate", "action" "new", "data" { "company" { "id" "04b9171e 6d74 451f a8e3 9bc3cf2b2954", "internal id" 23, "settings" { "token" "jb k123" } }, "candidate" { "id" "aed6532d 2438 4e33 b15b 1f1a20ba1c16", "internal id" 5903582, "first name" "bruce", "last name" "wayne", "email" "bruce\@wayneenterprises com", "phone number" "+468165621", "message" "please, don't call me before 5pm", "status" { "id" 5, "name" "hired", "group" 20 }, "files" { "cv" "https //jobylon com/jbl web bucket/applications/1/3/harald sigurdsson/mycv 22ac07f3 pdf?awsaccesskeyid=accesskeyawsuser\&signature=b8faztrin6pzwp%2f0hi4zsmzevl0%3d\&expires=1708531474", "cover letter" null, "other 1" null, "other 2" null, "other 3" null, "other 4" null, "other 5" null }, "data" { "iban" "se6281323143611896423859", "startingdate" "2025 01 01", "manager" \[ "selina kyle" ] } }, "job" { "id" "edc3d60e 53d3 4f54 8062 44e4139a52e9", "internal id" 4356, "title" "superhero", "from date" "2022 09 26", "to date" "2023 10 31", "description" "we are seeking an exceptional individual to join our team as a superhero as a superhero, you will be responsible for protecting the innocent, fighting crime, and maintaining peace and justice in our city this is a unique opportunity to use your extraordinary abilities and make a real difference in the lives of our community members ", "skills" "fast driver\nstealth and infiltration\nmaster of disguise", "locations" \[ { "location" "gotham, usa", "location json" { "city" "gotham", &#x9; "city short" "gt", &#x9; "country" "united states of america", &#x9; "country short" "us", &#x9; "area 1" "gotham county", &#x9; "area 1 short" "gotham county" } } ], "requisition" { "internal id" 123, "external id" "jb k123", "identifier" "jb k123", "title" "superhero" }, "experience" "minimum of 5 years fihgting the crime", "language" "en", "ad url" "https //jobylon com/jobs/3 super hero/", "settings" { "notes" "", "deadline" "2023 12 31", "requester" "peter parker", "notifybysms" "yes" } } } } company name type description id string company id internal id integer jobylon company internal identifier settings object company custom fields choices candidate name type description id string applicant id internal id integer jobylon application internal identifier first name string applicant first name last name string applicant last name email string applicant email phone number string applicant phone number message string applicant message status object applicant hiring status files object applicant files data object candidate custom fields choices status name type description id integer status id name string status name group integer status group status groups status new = 0 status in progress = 1 status rejected = 19 status hired = 20 status on hold = 21 files note all the urls of the following files are signed urls that expire after 24 hours name type description cv url signed url for the candidate's cv cover letter url signed url for the candidate's cover letter other 1 url signed url for the candidate's extra file 1 other 2 url signed url for the candidate's extra file 2 other 3 url signed url for the candidate's extra file 3 other 4 url signed url for the candidate's extra file 4 other 5 url signed url for the candidate's extra file 5 job name type description id string job id internal id integer jobylon job internal identifier title string job title from date date job publish date (job becomes publicly visible) to date date job closing date (job becomes hidden) description string job description skills string job skills locations object job locations experience string job required experience language string job language (alpha 2) ad url url job application url settings object job custom fields choices locations name type description location string location string location json object location details location json name type description city string city name city short string city short name (defaults to city) country string country name country short string country code (alpha 2) area 1 string name of city area area 1 short string short name of city area (defaults to area 1) requisition name type description internal id integer jobylon requisition internal identifier external id string requisition external id from the provider identifier string requisition identifier from the provider title string requisition title