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.
Sent when a company signs up to the partner integration
POST
Request
﻿
JSON
{
    "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"
        }
    }
}
{
    "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
Whenever a company triggers adding the settings to a Job, Jobylon sends a webhook to the configured endpoint with the job data described below. 
POST
Request
﻿
JSON
{
    "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",
			            "city_short": "GT",
			            "country": "United States of America",
			            "country_short": "US",
			            "area_1": "Gotham County",
			            "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"
            }
        }
    }
}
{
    "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",
			            "city_short": "GT",
			            "country": "United States of America",
			            "country_short": "US",
			            "area_1": "Gotham County",
			            "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
Whenever a company triggers sending a candidate to a Partner, Jobylon sends a webhook to the configured endpoint with the candidate data described below. 
POST
Request
﻿
Request Payload
JSON
{
    "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": "[email protected]",
            "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",
			            "city_short": "GT",
			            "country": "United States of America",
			            "country_short": "US",
			            "area_1": "Gotham County",
			            "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"
            }
        }
    }
}
{
    "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",
			            "city_short": "GT",
			            "country": "United States of America",
			            "country_short": "US",
			            "area_1": "Gotham County",
			            "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
﻿

Event type	Description
company	Company related event
job	Job related event
candidate	Candidate related event

Actions	Description
new	New object created
update	Object was updated (currently only job settings support this)
signup	Company enabled the integration

Status	Description
2XX	Success
4XX - 6XX	Something Went Wrong

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

Name	Type	Description
id	string	Company ID
internal_id	integer	Jobylon Company Internal Identifier
settings	object	Company Custom Fields Choices

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

Name	Type	Description
location	string	Location String
location_json	object	Location Details

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)

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

Name	Type	Description
id	string	Company ID
internal_id	integer	Jobylon Company Internal Identifier
settings	object	Company Custom Fields Choices

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

Name	Type	Description
id	integer	Status ID
name	string	Status Name
group	integer	Status Group*

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

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

Name	Type	Description
location	string	Location String
location_json	object	Location Details

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)

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

Api Reference/OpenAPI

Changelog