Skip to content

Instantly share code, notes, and snippets.

@azjgard
Created March 25, 2020 23:49
Show Gist options
  • Save azjgard/c0fc5997a1ae4d1046e0a201cbdfa086 to your computer and use it in GitHub Desktop.
Save azjgard/c0fc5997a1ae4d1046e0a201cbdfa086 to your computer and use it in GitHub Desktop.
Documentation for job XML feeds provided to Happy Monday

Happy Monday XML Feed Template

Thank you for choosing to partner with us!

  • Our system will scrape your XML feed 3 times per day.
  • If a job is no longer available, please exclude it to have the job removed from our system the next time we scrape your feed.
  • If a new job is available, please include it to have the job added to our system the next time we scrape your feed.
  • All data for a given job should be included in a <job> tag, and all <job> tags should be the top-level children of a root-level <jobs> tag (see the example further down this page).

Required Fields

  • id
    • A unique identifier to distinguish this job from all others.
  • title
    • The title of this job.
  • company_name
    • The name of the company the job has been posted on behalf of.
  • url
    • The url of page where applicants can apply for the job.
  • description
    • The description of the job. Ideal descriptions are longer than 500 characters. The following HTML tags are supported to enable basic formatting: <p>, <br>, <h1>, <h2>, <h3>, <strong>, <i>. Please ensure the value of description is properly wrapped with <![CDATA[ ]]>.
  • remote_type
    • An indication of the degree to which this job allows remote work.
    • Possible values:
      • never: the job will never allow working remotely.
      • sometimes: the job will sometimes allow working remotely, and the candidate will sometimes be able (or be required) to work onsite.
      • always: the job is fully remote.
    • If remote_type is never or sometimes, values are required for city, state, and country.

Optional Fields

  • city

    • The city the job is located in. This field is required only if remote_type is never or sometimes, and is optional otherwise.
    • Default value: null
  • state

    • The state/province the job is located in. This field is required only if remote_type is never or sometimes, and is optional otherwise.
    • Default value: null
  • country

    • The country the job is located in, or the country the company the job has been posted for is based out of.
    • Default value: us
  • company_contact

    • An email address by which a representative for the company posting the job can be reached.
    • Default value: null
  • min_compensation

    • The minimum compensation the job will provide. Include this without a value for max_compensation if the compensation for the job is not a range. If provided, should be a valid number without special characters.
    • Default value: null.
  • max_compensation

    • The maximum compensation the job will provide. Do not include this without a value for min_compensation. If provided, should be a valid number without special characters.
    • Default value: null.
  • compensation_interval

    • The interval at which the job will compensate the candidate placed in the role.
    • Should be one of the following values:
      • hourly
      • annually
    • Defaults to null.
  • currency

    • The currency of the specified compensation
    • Default value: usd

    Example

    <jobs>
      <job>
        <id>31fa816d-79f2-4b64-83d4-838c0d3653c8</id>
        <title>Senior Software Engineer</title>
        <company_name>Wonka Inc.</company_name>
        <url>
          <![CDATA[
            https://jobs.happymonday.com/t/wonka-inc/31fa816d-79f2-4b64-83d4-838c0d3653c8
          ]]>
        </url>
        <description>
          <![CDATA[
            <h2>Basic Responsibilities</h2>
              <p><strong>Lorem Ipsum</strong> is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.</p>
            <h2>Preferred Qualifications</h2>
            <p>
              It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).
            </p>
            <h2>About Wonka Inc</h2>
            <p>
              There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
            </p>
          ]]>
        </description>
        <remote_type>never</remote_type>
        <city>Scottsdale</city>
        <state>AZ</state>
        <country>USA</country>
        <company_contact>support@happymonday.com</company_contact>
        <min_compensation>90000</min_compensation>
        <max_compensation>110000</max_compensation>
        <currency>usd</currency>
        <compensation_interval>annually</compensation_interval>
      </job>
    </jobs>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment