JobAdder JobRelay field reference guide
This page outlines all of the data that is received in WordPress from JobAdder in the JobRelay feed.
Without any configuration, the job title is saved as the post title, the job description is saved as the post content and the job short description is saved as the post excerpt.
Required fields
JSON node | Data type | Example value | Notes |
---|---|---|---|
subscription_id | integer | 1 | The client subscription ID with JobRelay. This can be found on their subscriptions page in “My Account”. |
license_key | string | dfdf343fsf | The 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_url | string/url | https://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. |
password | string | aZkp3760rsAn | A password to authenticate the feed. Letters and numbers only. |
job_reference | string | REF-123 | A unique reference assigned to this job. |
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> |
command | string | add | Wither add , update or delete . |
application_email | string | tracking123@site.url | This is the email address used to track applications to this job. |
application_url | string | https://site.url/apply?job=12334 | The URL of the application form for this job, if not using a tracking email address. |
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 |
JobAdder fields
JSON node | Data type | Example value | Notes |
job_short_description | string | A short summary | A string of text to summarise the job. |
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. |
job_location | string | London, UK | |
job_type | string | Contract | The job/work type assigned. |
job_industry | string | IT | The job industry or category assigned. |
job_sub_category | string | Accounting | The sub category |
job_bullet_points | string | <ul><li>Point one</li></ul> | The HTML of bullet points added in JobAdder |
job_jid | string | 1568044 | The internal job id from JobAdder |
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.