JobRelay job fields

This page outlines all of the data that is sent to your website with each job via JobRelay.

Required fields

JSON nodeData typeExample valueNotes
subscription_idinteger1The client subscription ID with JobRelay. This can be found on their subscriptions page in “My Account”.
license_keystringdfdf343fsfThe license key assigned to the JobRelay user when they signed up. This should be included in their welcome email but can also be found on the purchase history page
site_urlstring/urlhttps://site.url/The URL of the site to which this users jobs should be ‘relayed’ too. Users should first add this site to their JobRelay My Account > Purchase history > View licenses > Manage sites area.
passwordstringaZkp3760rsAnA password to authenticate the feed. Letters and numbers only.
job_referencestringREF-123A unique reference assigned to this job.
job_titlestringWordPress DeveloperThe job title – no HTML allowed.
job_descriptionstringthe main description of the job. It can contain the following HTML elements
<img>
<a>
<strong>
<em>
<ul>
<ol>
<li>
commandstringaddWither add, update or delete.
application_emailstringtracking123@site.urlThis is the email address used to track applications to this job.
application_urlstringhttps://site.url/apply?job=12334The URL of the application form for this job, if not using a tracking email address.
job_sourcestringAwesome Job Posting ServiceA string representing the source of the job (where it was written). For example Broadbean, LogicMelon or Idibu

Optional fields

JSON nodeData typeExample valueNotes
job_short_descriptionstring
job_addressstringSandgate, UK, CT20 3ASThis is a precise address for the job. Likely used to gather geo data about a job.
contact_namestringJane SmithThe recruiters name.
contact_emailstringjane.smith@mail.comThe recruiters email
contact_telephonestring01234567890The recruiters telephone number.
contact_urlstring/urlhttps://site.urlThe recruiters website URL.
company_namestringJobRelayThe company name where the position is.
company_taglinestringRelaying JobsThe company tagline where the position is.
company_websitestring/urlhttps://jobrelay.ioThe company website where the position is.
company_twitterstring@jobrelayThe company twitter handle where the position is including the @ symbol.
company_logostring/urlhttps://img.com/im.jpgThe company logo where the position is. This should be a hosted image URL.
company_videostring/urlhttps://youtube.com/videoidA link to a video on a video sharing site such as Youtube.
expiry_datedate2020-12-01When the job expires or no longer takes applications. Should be in the format of YYY-MM-DD.
start_datestring2021-01-10 or ASAPWhen the job starts. Can be any string including in a date format.
salary_currencystringGBPCurrency code for the salary
salary_fromfloat10000A number (float) for the lower salary.
salary_tofloat15000A number (float) for the upper salary.
salary_perstringannumFor more information please see our Default Values.
salary_benefitsstringLaptop & healthcareFreetext, additional salary information.
salaryfloat15000A number (float) for the salary.
featuredboolean11 to mark as featured or 0 (default) to not be featured.
job_locationstringLondon, UK
job_typestringContractA pipe (|) separated list of job types.
job_industrystringITA pipe (|) separated list of job industries.
custom_datastringSome custom dataThis is an open text field for any additional information.