XML Feed Specs
XML Feed Tags
The XML feed contains basic tags (used once per feed), and a set of job tags (used in each job in the feed)
Basic Tags
| Tag | Required | Information | Example |
|---|---|---|---|
<?xml> | YES | XML declaration | <?xml version=”1.0" encoding=”utf-8"?> |
<source> | YES | The root tag for the XML document | <source> |
<publisher> | NO | The name of the company publishing this feed | Example Publisher |
<publisherurl> | NO | The URL of the company publishing this feed | https://www.example.com/ |
<job> | YES | Contains all the data needed for this job. We require one <job> element for each job | See next section titled “Job Tags” |
Job Tags
| Tag | Required | Information | Example Values |
|---|---|---|---|
<title> | YES | This is the title of the job. | <![CDATA[Software Engineer]]> |
<date> | YES | The date this job was first published. | <![CDATA[Mon, 05 Mar 2021 20:52:19 EST]]> |
<referencenumber> | YES | A Unique Identifier for the job. This can contain Letters and numbers. Do not change your referencenumber once you set it. | <![CDATA[distinctive123456]]> |
<url> | YES | The URL for the job listing. This should eventually connect the job seeker to a link to apply for the job | <![CDATA[http://www.example.com/viewjob.php?jobid=distinctive123456]]> |
<company> | YES | The company displayed in the search results. This should be the same company displayed on the landing page from the URL link in this job. | <![CDATA[ABC Technology Corporation]]> |
<latitude> | NO | The latitude for the job’s location. Used for map views and increased search results relevancy. | <![CDATA[30.3629]]> |
<longitude> | NO | The longitude for the job’s location. Used for map views and increased search results relevancy. | <![CDATA[-97.7931]]> |
<address> | NO | The main address line for the job’s location. Used for map views and increased search results relevancy. | <address><![CDATA[6433 Champion Grandview Way Bldg 2, Ste 100]]></address> |
<city> | NO | The city for the job’s location. If a City is added, we expect there to be a valid <state> tag. For all Cities in a state, leave the value blank or make the value <All Cities> | <![CDATA[New York]]> |
<state> | NO | The state for the job’s location. If a State is added, we expect there to be a valid <city> tag. For all States in the US, make the value <All States> | <![CDATA[NY]]> |
<postalcode> | YES | The postal code for the job’s location. While postal code is technically required and preferred, it can be omitted if the <city> and <state> tags are included and valid. | <![CDATA[10001]]> |
<description> | YES | The description for the job posting. The information in the description should match the description displayed in the <url> link. Job Descriptions support HTML formatting and basic HTML tags if encoded properly and encapsulated properly inside CDATA. | <![CDATA[Do you have 3-5 years of <b>software developing<b> experience?…]]> |
<campaign_id> | NO | Must be an integer. Can be used to group several jobs in this feed into individual campaigns. Talk with your Talroo POC if this is something you want to utilize. | <![CDATA[1]]> |
<segment> | NO | Must be an integer. After jobs are loaded into a campaign, This can be used to group jobs within a sub segment of a campaign. Talk with your Talroo POC if this is something you want to utilize. | <![CDATA[123]]> |
<email> | NO | Must be a valid email address. The email address of the recruiter that should receive new applicant emails, in addition to the programmatic application sends, for Talroo Apply Campaigns. | <![CDATA[example@example.com]]> |
<cpc> | NO | cpc (aka: “Cost per Click”) Must be a Float. In Dollars. Required for “cpc per click”. Do not use if using the <target_cpa> tag. This must be greater than the minimum required CPC for the Industry or Product you will be using. Please ask your Talroo POC for more details. | <![CDATA[0.50]]> |
<target_cpa> | NO | Target or goal CPA (aka: “Cost per application”) Must be a Float. In Dollars. Required for Job Level Target CPA Bidding Strategy. When using Job Level Target CPA Bidding Strategy, jobs without a <target_cpa> value will default to using to the jobCampaign.target_cpa value of the Campaign they are assigned to. Do not use if using the <cpc> tag. | <![CDATA[19.5]]> |
<talroo_apply> | NO | Used to house nodes that power the Talroo Apply system. See Talroo Apply XML Job Feed. | - |
<custom_questions> | NO | URL location of Application question JSON. See Talroo Apply XML Job Feed. | <![CDATA[https://example.com/custom_questions.json]]> |
<postUrl> | NO | URL Talroo will POST applications to. See Talroo Apply XML Job Feed. | <![CDATA[https://example.com/postUrl]]> |
<addressCollection> | NO | Whether this job's application should require an applicant provide their address. Values options of off, optional, and required are case insensitive. See Talroo Apply - Applicant Address. | <![CDATA[false]]> |
<resume_required> | NO | Whether this job's application should require a resume. See Talroo Apply - Applicant Resume. | <![CDATA[false]]> |
XML Feed Example
<?xml version="1.0" encoding="utf-8"?>
<source>
<publisher>Example</publisher>
<publisherurl>http://www.example.com</publisherurl>
<lastBuildDate>Mon, 05 Mar 2021 20:52:19 EST</lastBuildDate>
<job>
<title><![CDATA[Software Engineer]]></title>
<date><![CDATA[Mon, 05 Mar 2021 20:52:19 EST]]></date>
<referencenumber><![CDATA[distinctive123456]]></referencenumber>
<url>
<![CDATA[http://www.example.com/viewjob.php?jobid=distinctive123456]]>
</url>
<company><![CDATA[ABC Technology Corporation]]></company>
<latitude><![CDATA[30.3629]]></latitude>
<longitude><![CDATA[-97.7931]]></longitude>
<address><![CDATA[6433 Champion Grandview Way Bldg 2, Ste 100]]></address>
<city><![CDATA[Austin]]></city>
<state><![CDATA[TX]]></state>
<postalcode><![CDATA[78750]]></postalcode>
<description>
<![CDATA[Do you have 3-5 years of software developing experience? Are you a big fan of new developing languages? Are you ready for an exciting and high-speed career in engineering? If so, we want to hear from you!<br />
We provide competitive compensation, including stock options and a full benefit plan. As a fast-growing business, we offer excellent opportunities for exciting and challenging work. As our company continues to grow, you can expect unlimited career advancement!]]>
</description>
<campaign_id><![CDATA[1]]></campaign>
<segment><![CDATA[123]]></segment>
<target_cpa><![CDATA[19.5]]></target_cpa>
<email><![CDATA[example@example.com]]></email>
<!--Only utilized with Talroo Apply system-->
<talroo_apply>
<custom_questions><![CDATA[https://example.com/custom_questions.json]]></custom_questions>
<postUrl><![CDATA[https://example.com/postUrl]]></postUrl>
<addressCollection><![CDATA[required]]></addressCollection>
<resume_required><![CDATA[false]]></resume_required>
</talroo_apply>
</job>
</source>
Common Mistakes
| Mistake | Solution |
|---|---|
| Incorrect use of CDATA | See here for details on how to use CDATA |
| Suspected Invalid Advertisements | We reserve the right to remove an invalid advertisement from our system if determined the job is not a valid job opportunity. |
| Invalid Character Encoding | Use an XML linter tool or browser “view source” to determine if your XML feed is encoded incorrectly |
Additional Information (Common Questions)
What are the options for sending us the feed?
Talroo can call a URL link to your XML feed directly and download the file. Talroo can provide access to our SFTP server for you to upload your jobs.
How often is your feed refreshed in our system?
Talroo will refresh your feed at least once every 24 hours.
Can I include additional tags?
Yes, as long as the required tags are included.
How do I display Jobs that are statewide or nationwide?
For State Wide: Simply do not include a <postalcode> tag and make the value of your <city> tag “All Cities” or leave the <city> tag value blank.
For Nationwide: Do not include a <postalcode> tag. Set the value of the <state> tag to “All States” and your <city> tag to “All Cities”.