{"_id":"59de6011debd1200240f690b","user":"547504ed59fade080004cb8b","parentDoc":null,"__v":0,"version":{"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z","categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"category":{"_id":"59de6011debd1200240f68fd","project":"59de6011debd1200240f68ec","__v":0,"version":"59de6011debd1200240f68ee","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-06-21T21:33:48.049Z","from_sync":false,"order":1,"slug":"api-use-cases","title":"API Use Cases"},"project":"59de6011debd1200240f68ec","githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-21T22:57:21.120Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"Several clients choose to host their hiring page on their primary website, and seamlessly forward applicants into the Fountain portal to increase conversion. To utilize this functionality, send our API a Create Applicant POST request, and we'll respond with an applicant_id. \n\n## POST\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X POST -H 'Content-Type: application/json' -d '{\\\"name\\\":\\\"John\\\",\\\"email\\\":\\\"john:::at:::gmail.com\\\",\\\"phone_number\\\":\\\"5034834844\\\",\\\"api_token\\\":\\\"secret-api-token\\\",\\\"data\\\":{\\\"city\\\":\\\"San Francisco\\\",\\\"transportation\\\":\\\"Bicycle\\\"}}' 'https://api.fountain.com/v2/applicants'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nOnce upon processing the POST request, you'll get a response containing your new applicant's Fountain data.\n\n## Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"e8e4edc5-096c-47ea-b682-f77c6c4462dd\\\",\\n  \\\"email\\\": \\\"john@gmail.com\\\",\\n  \\\"name\\\": \\\"John\\\",\\n  \\\"phone_number\\\": \\\"5034834844\\\",\\n  \\\"data\\\": {\\n    \\\"city\\\": \\\"San Francisco\\\",\\n    \\\"transportation\\\": \\\"Bicycle\\\",\\n    }\\n  },\\n  \\\"created_at\\\": \\\"2015-06-05T05:53:46.749-07:00\\\",\\n  \\\"funnel\\\": {\\n    \\\"id\\\": \\\"de79f80f-43da-4e4c-87d6-9bf714753535\\\",\\n    \\\"title\\\": \\\"San Francisco Bicycles\\\"\\n  },\\n  \\\"stage\\\": {\\n    \\\"id\\\": \\\"4d09fca4-6599-4418-b385-6cf173e01b66\\\",\\n    \\\"title\\\": \\\"Phone Screen\\\"\\n  },\\n  \\\"background_checks\\\": [],\\n  \\\"document_signatures\\\": [],\\n  \\\"labels\\\": []\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nAppend the response's applicant id to the end of your portal URL (https://fountain.com/portal/:account_slug/applicant_result/:id), and redirect the applicant there. They'll automatically land in the first stage of the applicant portal. If you have set up several eligibility filters in Fountain, the applicant will receive the appropriate messaging based on their status in the workflow.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Note: UTM Tracking\",\n  \"body\": \"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.\"\n}\n[/block]","excerpt":"","slug":"connecting-a-custom-form-to-the-onboardiq-applicant-portal","type":"basic","title":"Connecting a Custom Form"}

Connecting a Custom Form


Several clients choose to host their hiring page on their primary website, and seamlessly forward applicants into the Fountain portal to increase conversion. To utilize this functionality, send our API a Create Applicant POST request, and we'll respond with an applicant_id. ## POST [block:code] { "codes": [ { "code": "curl -X POST -H 'Content-Type: application/json' -d '{\"name\":\"John\",\"email\":\"john@gmail.com\",\"phone_number\":\"5034834844\",\"api_token\":\"secret-api-token\",\"data\":{\"city\":\"San Francisco\",\"transportation\":\"Bicycle\"}}' 'https://api.fountain.com/v2/applicants'", "language": "curl" } ] } [/block] Once upon processing the POST request, you'll get a response containing your new applicant's Fountain data. ## Response [block:code] { "codes": [ { "code": "{\n \"id\": \"e8e4edc5-096c-47ea-b682-f77c6c4462dd\",\n \"email\": \"john@gmail.com\",\n \"name\": \"John\",\n \"phone_number\": \"5034834844\",\n \"data\": {\n \"city\": \"San Francisco\",\n \"transportation\": \"Bicycle\",\n }\n },\n \"created_at\": \"2015-06-05T05:53:46.749-07:00\",\n \"funnel\": {\n \"id\": \"de79f80f-43da-4e4c-87d6-9bf714753535\",\n \"title\": \"San Francisco Bicycles\"\n },\n \"stage\": {\n \"id\": \"4d09fca4-6599-4418-b385-6cf173e01b66\",\n \"title\": \"Phone Screen\"\n },\n \"background_checks\": [],\n \"document_signatures\": [],\n \"labels\": []\n}", "language": "json" } ] } [/block] Append the response's applicant id to the end of your portal URL (https://fountain.com/portal/:account_slug/applicant_result/:id), and redirect the applicant there. They'll automatically land in the first stage of the applicant portal. If you have set up several eligibility filters in Fountain, the applicant will receive the appropriate messaging based on their status in the workflow. [block:callout] { "type": "info", "title": "Note: UTM Tracking", "body": "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." } [/block]