Push API and Webhooks
API
Application
model in jobylon every candidate can be represented by one or more applications, where every application relates to a job to run the examples export host='https //staging jobylon com' export api version='p1' export app id='0123456789123456' export app key='abc123xyz' basic example \# request curl i \\ x post "$host/$api version/applications/" \\ h "x app id $app id" \\ h "x app key $app key" \\ h "content type application/json" \\ d '{ "job id" 123456789, "first name" "kalle", "last name" "kula", "email" "kalle\@kula se", "phone" "+4670 123456789", "ln url" "https //www linkedin com/in/kalle kula 123a4567", "cv url" "https //www w3 org/wai/er/tests/xhtml/testfiles/resources/pdf/dummy pdf", "message" "message from the applicant ", "source type" "applied", "source json" { "partner name" "best source", "message" "some other message ", "referrer" { "name" "kella kalu", "email" "kello\@kalu se", "phone" "+46123456789", "avatar" "https //gravatar com/avatar/ce757a5d51e6285434134e7b6c96ab86?s=200\&d=robohash\&r=g" }, "questions" \[ { "order" 1, "question" "why should we hire the person?", "question type" "text", "answer" "because she is great!" }, { "order" 2, "question" "rank the skills", "question type" "range", "question args" { "min" 1, "max" 5, "step" 1, "unit" "star" }, "answer" 4 }, { "order" 3, "question" "where can they be located?", "question type" "select multiple", "question alternatives" \[ "avesta", "london", "moskva", "new york", "paris", "stockholm" ], "answer" \[ "london", "new york", "paris", "stockholm" ] }, { "order" 4, "question" "do they have a eu work permit?", "question type" "select one", "answer" "yes" } ] } "original referrer" "https //bestreferrals com/?utm source=google\&utm medium=cpc\&utm term=earn referrals", "ab test" "abtestid", "answers" \[ { "question id" 1, "text" \[ "i am ready to start in the beggining of next month " ] }, { "question id" 2, "text" \[ "swedish", "english", "norwegian" ] }, ], "status id" 1 }' \# response status code 201 created content type application/json {'id' 123} example using a local json file \# request curl i \\ x post "$host/$api version/applications/" \\ h "x app id $app id" \\ h "x app key $app key" \\ h "content type application/json" d @\<path to file> example with files attached (multipart/form data) \# request curl i \\ x post "$host/$api version/applications/" \\ h "x app id $app id" \\ h "x app key $app key" \\ f "job id=55" \\ f "first name=kalle" \\ f "last name=kula" \\ f "email=kalle\@kula se" \\ f "phone=+4670 123456789" \\ f "message=message from the applicant " \\ f "source type=applied" \\ f "source json={ \\"partner name\\" \\"best source\\", \\"message\\" \\"some other message \\" }" \\ f "cv=@cv pdf" \\ f "cover letter=@cover letter pdf" \\ f "other 1=@other 1 pdf" \\ f "other 2=@other 2 pdf" \\ f "other 3=@other 3 pdf" \\ f "other 4=@other 4 pdf" \\ f "other 5=@other 5 pdf" create post /applications/ query string parameters none request payload name type mandatory? description job id integer yes applicant first name first name string yes applicant first name last name string yes applicant last name email string applicant email phone string applicant phone ln url url applicant linkedin url (will be validated) message string message from the applicant source type string yes source type (applied/applied silent/recommended/sourced) if set to applied, a thank you email will be sent to the applicant source json object yes additional source data (partner dependent, but using the data from the example will be nicely styled in jobylon cv file application file (supported using multipart/form data) cv url url url to the file to be downloaded and assigned to the field cover letter file application file (supported using multipart/form data) cover letter url url url to the file to be downloaded and assigned to the field other 1 file application file (supported using multipart/form data) other 1 url url url to the file to be downloaded and assigned to the field other 2 file application file (supported using multipart/form data) other 2 url url url to the file to be downloaded and assigned to the field other 3 file application file (supported using multipart/form data) other 3 url url url to the file to be downloaded and assigned to the field other 4 file application file (supported using multipart/form data) other 4 url url url to the file to be downloaded and assigned to the field other 5 file application file (supported using multipart/form data) other 5 url url url to the file to be downloaded and assigned to the field ab test string a unique identifier used for a/b testing original referrer string value used to keep track on the application origin (used in analytics) answers array array of answers to the job questions status id integer id of the application status answers object \[ { "question id" 1, "text" \[ "driver's license category b", "driver's license category d" ] } ] question id text id of the question list of answers to the question some questions support multiple choices response name type description id integer application id exceptions status description 400 bad request, job id that app doesn't have access to 403 permission denied 405 method not supported retrieve a pushapi partner can only retrieve applications that have been created by that partner applications created by another partner or created in jobylon using other means will not be available get /applications/\<application id> query string parameters none response name type description status id integer status id exceptions status description 403 permission denied 404 application not found update a pushapi partner can only update applications that have been created by that partner applications created by another partner or created in jobylon using other means will not be available put /applications/\<application id>/ patch /applications/\<application id>/ query string parameters none request payload status id is the only field that can be updated name type description status id integer status id response name type description status id integer status id exceptions status description 400 bad request the status id does not exist 403 permission denied 404 application not found