Home » Documents » Broadbean JobRelay field reference guide

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 node	Data type	Example value	Notes
job_title	string	WordPress Developer	The job title – no HTML allowed.
job_description	string		the main description of the job. It can contain the following HTML elements `<img>` `<a>` `<strong>` `<em>` `<ul>` `<ol>` `<li>`
job_short_description	string	A short summary	A string of text to summarise the job.
job_source	string	Awesome Job Posting Service	A 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 node	Data type	Example value	Notes
job_short_description	string
contact_name	string	Jane Smith	The recruiters name.
contact_email	string	jane.smith@mail.com	The recruiters email
contact_telephone	string	01234567890	The recruiters telephone number.
contact_url	string/url	https://site.url	The recruiters website URL.
company_name	string	JobRelay	The company name where the position is.
company_tagline	string	Relaying Jobs	The company tagline where the position is.
company_website	string/url	https://jobrelay.io	The company website where the position is.
company_twitter	string	@jobrelay	The company twitter handle where the position is including the `@` symbol.
company_logo	string/url	https://img.com/im.jpg	The company logo where the position is. This should be a hosted image URL.
company_video	string/url	https://youtube.com/videoid	A link to a video on a video sharing site such as Youtube.
expiry_date	date	2020-12-01	When the job expires or no longer takes applications. Should be in the format of `YYY-MM-DD`.
start_date	string	2021-01-10 or ASAP	When the job starts. Can be any string including in a date format.
salary_currency	string	GBP	Currency code for the salary
salary_from	float	10000	A number (float) for the lower salary.
salary_to	float	15000	A number (float) for the upper salary.
salary_per	string	annum	For more information please see our Default Values.
salary_benefits	string	Laptop & healthcare	Freetext, additional salary information.
salary	float	15000	A number (float) for the salary.
featured	boolean	1	`1` to mark as featured or `0` (default) to not be featured.
job_location	string	London, UK	The formatted location string.
job_location_raw	string	Europe > England > London	The raw location string.
custom_data	string	Some custom data	This 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 node	Data type	Example value	Notes
job_type	string	Contract	A pipe (`\|`) separated list of job types.
job_industry	string	IT	A pipe (`\|`) separated list of job industries.
working_arrangement	string	Remote	One 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 node	Data type	Example value	Notes
geo_lat	float	53.19339	The latitude of the job location.
geo_long	float	-2.89075	The longitude of the job location.
geo_formatted_address	string	Chester, UK	The formatted address of the location sent.
geo_city	string	Chester	The name of the city for the geo located location
geo_country_short	string	GB	The shortened country name for the geo located location
geo_country_long	string	United Kingdom	The long country name for the geo located location
geo_administrative_area_level_2_short	string	Cheshire West and Chester	The short version of the second level administrative area.
geo_administrative_area_level_2_long	string	Cheshire West and Chester	The long version of the second level administrative area.
geo_administrative_area_level_1_short	string	England	The short version of the first level administrative area.
geo_administrative_area_level_1_long	string	England	The 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.