Connecting a Custom Form

Several clients choose to host their hiring page on their primary website, and seamlessly forward applicants into the Fountain Hire portal to increase conversion. To utilize this functionality, use our API endpoint Create an Applicant to make a POST request, and we'll respond with an applicant_id. Note that the code responsible for calling the Hire API endpoint needs to reside server side so that your Hire API token is not exposed through client-side code; failure to do so could lead to abuse of your API token and the creation of spam applicants.

POST Create an Applicant Request

curl -X POST -H 'Content-Type: application/json' -H 'X-ACCESS-TOKEN: secret-api-token' -d '{"name":"John","email":"[email protected]","phone_number":"5034834844","data":{"city":"San Francisco","transportation":"Bicycle"}}' 'https://api.fountain.com/v2/applicants'

Once upon processing the POST request, you'll get a response containing your new applicant's Fountain Hire data.

Response

{
  "id": "e8e4edc5-096c-47ea-b682-f77c6c4462dd",
  "email": "[email protected]",
  "name": "John",
  "phone_number": "5034834844",
  "data": {
    "city": "San Francisco",
    "transportation": "Bicycle",
    }
  },
  "created_at": "2015-06-05T05:53:46.749-07:00",
  "funnel": {
    "id": "de79f80f-43da-4e4c-87d6-9bf714753535",
    "title": "San Francisco Bicycles"
  },
  "stage": {
    "id": "4d09fca4-6599-4418-b385-6cf173e01b66",
    "title": "Phone Screen"
  },
  "background_checks": [],
  "document_signatures": [],
  "labels": [],
  "portal_url": "https://fountain.com/apply/example/e8e4edc5-096c-47ea-b682-f77c6c4462dd"
}

There is a key returned in the response that is the URL to continue the application called portal_url. Redirect the applicant to this URL. They'll automatically land in the first stage of the applicant portal. If you have set up several eligibility filters in Fountain Hire, the applicant will receive the appropriate messaging based on their status in the workflow.

📘

Note: UTM Tracking

To use UTM tracking for your form, simply pass the desired UTM fields (i.e. "utm_source"="craigslist") along with the rest of an applicant's data.