Broadbean JobRelay field reference guide

This page outlines all of the data that is received in WordPress from Broadbean in the JobRelay feed.

Auto mapped fields

These fields are sent by the posting provider and automatically mapped to be saved in WordPress. Job title is saved as the post title, job description saved to the post content and the job short description is saved as the post excerpt.

JSON nodeData typeExample valueNotes
job_titlestringWordPress DeveloperThe job title – no HTML allowed.
job_descriptionstringthe main description of the job. It can contain the following HTML elements
job_short_descriptionstringA short summaryA string of text to summarise the job.
job_sourcestringAwesome Job Posting ServiceA string representing the source of the job (where it was written). For example Broadbean, LogicMelon or Idibu

The job post date will be the date and time when the job was posted to JobRelay.

Fields which need to be mapped

These are fields sent in the data feed from Broadbean that need a mapping in WordPress. If they are not mapped to either meta or taxonomies, they will not be saved.

Learn how to map JobRelay fields in WordPress.

Standard fields

These fields don’t have values that are selected in Broadbean. The values are entered into the Broadbean inputs.

JSON nodeData typeExample valueNotes
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/url company logo where the position is. This should be a hosted image URL.
company_videostring/url 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, UKThe formatted location string.
job_location_rawstringEurope > England > LondonThe raw location string.
custom_datastringSome custom dataThis is an open text field for any additional information.

Multi-select fields

These are the fields that have multi-options from which to select from in Broadbean.

JSON nodeData typeExample valueNotes
job_typestringContractA pipe (|) separated list of job types.
job_industrystringITA pipe (|) separated list of job industries.
working_arrangementstringRemoteOne of either “Remote”, “Hybrid” or “Office based”. If none selected and empty field is sent.

Note: the options that appear in the multi-select fields for job type and job industry are pulled from WordPress on feed setup. When your JobRelay feed is setup, it is important that the correct job types and industries are added in WordPress.

Custom fields

Broadbean support up to 5 custom fields in the feed which can be used for other data. Each of these fields is a multi-select field as is required if entered into the feed.

These fields are labelled in Broadbean as “Custom Field 1” etc. They are sent in the JobRelay feed as custom_field_1 etc.

Find out more about using custom fields with JobRelay and Broadbean here.

Geo location fields

These fields are available for all providers. The providers don’t actually send this data. It is generated by JobRelay for each job and then sent onto your WordPress website.

JSON nodeData typeExample valueNotes
geo_latfloat53.19339The latitude of the job location.
geo_longfloat-2.89075The longitude of the job location.
geo_formatted_addressstringChester, UKThe formatted address of the location sent.
geo_citystringChesterThe name of the city for the geo located location
geo_country_shortstringGBThe shortened country name for the geo located location
geo_country_longstringUnited KingdomThe long country name for the geo located location
geo_administrative_area_level_2_shortstringCheshire West and ChesterThe short version of the second level administrative area.
geo_administrative_area_level_2_longstringCheshire West and ChesterThe long version of the second level administrative area.
geo_administrative_area_level_1_shortstringEnglandThe short version of the first level administrative area.
geo_administrative_area_level_1_longstringEnglandThe long version of the first level administrative area.

It is worth noting that not all of this data is available for every job. JobRelay uses the Google Geo coding API to obtain Geo data for each job, using the job_location field.

The location is run through the API and the resulting data sent on. Depending on the location string, not all this data may be available.

For example, if the location sent via JobRelay is Lancashire, UK, a geo_city value will not be present. This is because the location is not specific enough to return a city value.