XML Feed Reference

Snagajob's XML feed nodes, elements, and examples.

General feed nodes

Element
Required
Description
Example

<?xml ?>

Yes

XML declaration

<?xml version='1.0' encoding='UTF-8'?>

<Postings>

Yes

Root node for the XML feed document.

<Item>

Yes

Job-specific metadata.

Job feed elements

Job feed elements define job-specific metadata for a <Item> node.

Element
Required
Description
Example

<Brand>

Yes

The Brand name that is displayed on Snagajob search results.

<![CDATA[ABC Company]]>

<Job_Title>

Yes

The title of the job.

<![CDATA[Data Entry Clerk]]>

<Employment_Type>

The type of job, full- or part-time. Defaults to FullTime,PartTime if left blank. Accepted values: FullTime PartTime Gig

<![CDATA[FullTime]]>

<Wage>

Preferably a number like $10.00 (Including a currency symbol) or minimum to maximum range, and wording that uses hourly, such as “$10 - 15 per hour” are also acceptable.

<![CDATA[$10 - 15 per hour]]>

<Location_Name>

Preferably a store location number, street address, or city, state zip. Must be unique per location.

<![CDATA[Main Store 123]]>

<Address_Line_1>

The street address of the job's primary work location. Please include the street name and number. Street address may be used by Snagajob to improve the precision of location-based job search and will be displayed to job seekers.

<![CDATA[123 Main St]]>

<City>

Yes

The city in which this job is located. Must be a valid city based on USPS validation. If an invalid city is sent, the job will not be posted.

<![CDATA[Richmond]]>

<State>

Yes

The state in which this job is located. Must be a State abbreviation (ex. VA, CA, FL)

<![CDATA[VA]]>

<Zip>

The postal code in which this job is located. If the zip is not provided, then Snagajob will assign one. Zip is based on USPS standards and must only be the first five digits. The job will not be posted if the postal code and city do not align.

<![CDATA[23225]]>

<Job_Description>

Yes

Include HTML formatting with the Job Description text. The text will be displayed without formatting if HTML formatting is not included. Phone numbers and External URLs will be removed.

<![CDATA[Something interesting about this posting.]]>

<Primary_Industry>

Yes

<![CDATA[Automotive]]>

<URL>

Yes

The URL for this job listing on your site. The apply URL must begin with http:// or https://.

<![CDATA[http://www.exampleats.com/job1]]>

<External_Posting_ID>

Yes

Unique identifier per job posting. Snagajob uses this element to identify each job. Avoid changing this number once you’ve set it.

<![CDATA[123_unique_id]]>

<Rate>

The Cost Per Click (CPC) bidding Rate. Formatted as ##.##

<![CDATA[10.00]]>

<Location_Number>

This field represents the Store number. While this element is not required, it’s highly encouraged to include

<![CDATA[123]]>

<TrackingUrl>

The URL to which Snagajob will send click data. Snagajob creates a GET request to this URL each time a worker clicks the ‘Apply Now’ button on Snagajob.

<![CDATA[https://myapplicantapi.com/where-clicks-should-go]]>

<LogoUrl>

An image URL for the brand associated with the posting. Strongly recommended for maximizing performance.

<![CDATA[https://myapplicantapi.com/where-snagajob-should-find-my-logo-image/logo.png]]>

Aggregate Job Feed Elements

Element
Required
Description
Example

<Feed_Source>

A unique string to group employers so that a given partner can provide more than 1 aggregate file.

<![CDATA[Feed_ID_1]]>

<Employer_ID>

An ID that uniquely identifies an employer. This while preferability match the ID of the employer in your system.

<![CDATA[12345]]>

<Employer_Name>

The parent organization name.

For example, if subsidiaries or franchises have multiple <Brand> names under the same company, the <Employer_Name> would be the same for all those jobs.

<![CDATA[Parent Company Inc]]>

Easy Apply feed elements

Element
Required
Description
Example

<PostUrl>

Yes for Easy Apply

<![CDATA[https://myapplicantapi.com/where-applications-should-go]]>

<ScreeningQuestionsUrl>

Yes for Easy Apply

<![CDATA[https://myapplicantapi.com/where-we-find-questions]]>

Campaign feed elements

Field Name
Required
Description
Example

<Campaign_Id>

Yes for campaigns

The unique ID for a campaign in your system. This ID will correspond to the ID value passed in the XML feed.

<![CDATA[123_test_id]]>

<Campaign_Name>

Yes for feed campaigns

The name of the campaign. It does not have to be unique.

<![CDATA[Test_Campaign_123]]>

<Application_Goal>

The targeted number of applications for this campaign.

<![CDATA[10]]>

<CPA_Goal>

Recommend for best performance

<![CDATA[15]]>

<CPC>

The value of an actual bid set at the campaign level.

<![CDATA[6]]>

<Budget>

The designated budget for the campaign.

<![CDATA[150]]>

<Campaign_Start>

<![CDATA[2023-08-01T00:00:000Z]]>

<Campaign_End>

<![CDATA[2023-08-31T00:00:000Z]]>

XML Examples

Single Customer Feed XML Example

<?xml version='1.0' encoding='UTF-8'?>
<Postings>   
    <Item>
        <Brand><![CDATA[Feed Cleaning Co]]></Brand>
        <Job_Title><![CDATA[Meat Server]]></Job_Title>
        <Employment_Type><![CDATA[Gig]]></Employment_Type>
        <Wage><![CDATA[$10.00]]></Wage>
        <Location_Name><![CDATA[Surrugiv]]></Location_Name>
        <Address_Line_1><![CDATA[714 Naskog Drive]]></Address_Line_1>
        <City><![CDATA[Glen Allen]]></City>
        <State><![CDATA[VA]]></State>
        <Zip><![CDATA[23060]]></Zip>
        <Job_Description><![CDATA[Delish]]></Job_Description>
        <Primary_Industry><![CDATA[CustomerService]]></Primary_Industry>
        <URL><![CDATA[https://google.com]]></URL>
        <External_Posting_ID><![CDATA[4116484012]]></External_Posting_ID>
        <Location_Number><![CDATA[54]]></Location_Number>
        <LogoUrl><![CDATA[https://myapplicantapi.com/where-snagajob-should-find-my-logo-image/logo.png]]></LogoUrl>
        <TrackingUrl><![CDATA[https://myapplicantapi.com/where-clicks-should-go]]></TrackingUrl>
        <!--BEGIN EASY APPLY INFO-->
        <!--Easy Apply elements are only applicable to partners with an Easy Apply integration-->
        <PostUrl><![CDATA[https://myapplicantapi.com/where-applications-should-go]]></PostUrl>
        <ScreeningQuestionsUrl><![CDATA[https://myapplicantapi.com/where-we-find-questions]]></ScreeningQuestionsUrl>
        <!--END EASY APPLY INFO-->
        <!--BEGIN CAMPAIGN INFO-->
        <!--campaign details are only applicable to those managing campaigns using their XML feed-->
        <Campaign_Id><![CDATA[another_test_id]]></Campaign_Id>
        <Budget><![CDATA[1000]]></Budget>
        <CPA_Goal><![CDATA[10]]></CPA_Goal>
        <Campaign_Name><![CDATA[Test_Campaign_1]]></Campaign_Name>
        <Campaign_Start><![CDATA[2023-06-02T00:00:000Z]]></Campaign_Start>
        <Campaign_End><![CDATA[2023-06-30T00:00:000Z]]></Campaign_End>
        <!--END CAMPAIGN INFO-->
    </Item>
</Postings>

Aggregate Feed XML Example

<?xml version='1.0' encoding='UTF-8'?>
<Postings>
    <Feed_Source><![CDATA[SomeUniqueSourceThatGroupsEmployersTogether]]></Feed_Source>
    <Item>
        <!--posting associated with the first <Employer_ID>-->
        <Employer_ID><![CDATA[12345]]></Employer_ID>
        <Employer_Name><![CDATA[The Parent Employer Inc]]></Employer_Name>
        <Brand><![CDATA[YourCompany]]></Brand>
        <Job_Title><![CDATA[Search Engine Evaluator - Work From Home]]></Job_Title>
        <Employment_Type><![CDATA[FullTime]]></Employment_Type>
        <Wage><![CDATA[$10.00 - $15.00 per hour]]></Wage>
        <Location_Name><![CDATA[Glen Allen Store 123]]></Location_Name>
        <Address_Line_1><![CDATA[123 Test Street]]></Address_Line_1>
        <City><![CDATA[Glen Allen]]></City>
        <State><![CDATA[VA]]></State>
        <Zip><![CDATA[23260]]></Zip>
        <Rate><![CDATA[10.00]]></Rate>
        <Job_Description><![CDATA[Thanks for your interest!]]></Job_Description>
        <Primary_Industry><![CDATA[Customer Service]]></Primary_Industry>
        <URL><![CDATA[https://www.yourats.com/12345_testID]]></URL>
        <External_Posting_ID><![CDATA[12345_testID]]></External_Posting_ID>
        <Location_Number><![CDATA[123]]></Location_Number>
        <LogoUrl><![CDATA[https://myapplicantapi.com/where-snagajob-should-find-my-logo-image/logo.png]]></LogoUrl>
        <TrackingUrl><![CDATA[https://myapplicantapi.com/where-clicks-should-go]]></TrackingUrl>
        <!--BEGIN EASY APPLY INFO-->
        <!--Easy Apply elements are only applicable to partners with an Easy Apply integration-->
        <PostUrl><![CDATA[https://myapplicantapi.com/where-applications-should-go]]></PostUrl>
        <ScreeningQuestionsUrl><![CDATA[https://myapplicantapi.com/where-we-find-questions]]></ScreeningQuestionsUrl>
        <!--END EASY APPLY INFO-->
        <!--BEGIN CAMPAIGN INFO-->
        <!--campaign details are only applicable to those managing campaigns using their XML feed-->
        <Campaign_Id><![CDATA[another_test_id]]></Campaign_Id>
        <Budget><![CDATA[1000]]></Budget>
        <CPA_Goal><![CDATA[10]]></CPA_Goal>
        <Campaign_Name><![CDATA[Test_Campaign_1]]></Campaign_Name>
        <Campaign_Start><![CDATA[2023-06-02T00:00:000Z]]></Campaign_Start>
        <Campaign_End><![CDATA[2023-06-30T00:00:000Z]]></Campaign_End>
        <!--END CAMPAIGN INFO-->
    </Item>
    <Item>
        <!--posting associated with a second <Employer_ID>-->
        <Employer_ID><![CDATA[employer2]]></Employer_ID>
        <Employer_Name><![CDATA[TheEmployerName2]]></Employer_Name>
        <Brand><![CDATA[YourCompany]]></Brand>
        <Job_Title><![CDATA[Search Engine Evaluator - Work From Home]]></Job_Title>
        <Employment_Type><![CDATA[FullTime]]></Employment_Type>
        <Wage><![CDATA[$10.00 - $15.00 per hour]]></Wage>
        <Location_Name><![CDATA[Glen Allen Store 123]]></Location_Name>
        <Address_Line_1><![CDATA[123 Test Street]]></Address_Line_1>
        <City><![CDATA[Glen Allen]]></City>
        <State><![CDATA[VA]]></State>
        <Zip><![CDATA[23260]]></Zip>
        <Rate><![CDATA[10.00]]></Rate>
        <Job_Description><![CDATA[Thanks for your interest!]]></Job_Description>
        <Primary_Industry><![CDATA[Customer Service]]></Primary_Industry>
        <URL><![CDATA[https://www.yourats.com/12345_testID]]></URL>
        <External_Posting_ID><![CDATA[12345_testID]]></External_Posting_ID>
        <Location_Number><![CDATA[123]]></Location_Number>
        <LogoUrl><![CDATA[https://myapplicantapi.com/where-snagajob-should-find-my-logo-image/logo.png]]></LogoUrl>
    </Item>
</Postings>

Appendix

Industry Options

  • Accounting & Finance

  • Administration & Office Support

  • Agriculture & Environment

  • Automotive

  • Computers & Technology

  • Construction

  • Customer Service

  • Education

  • Food & Restaurant

  • Government & Military

  • Healthcare

  • Hotel & Hospitality

  • Installation & Repair

  • Law Enforcement & Security

  • Legal

  • Maintenance & Janitorial

  • Management

  • Media & Entertainment

  • Other

  • Personal Care & Services

  • Retail

  • Sales & Marketing

  • Salon/Spa/Fitness

  • Social Services

  • Transportation

  • Warehouse & Production

  • Wellness

  • Work at Home

Last updated

Was this helpful?