Configuration

Fountain Partner API

Communicating with Fountain's Partner API

Fountain's Partner API is authenticated using API keys. You'll need to include your API key (which will be provided to you when you set up your integration) in the header of each API request. Please contact the Fountain team at partners@fountain.com to request access.

When your service integrates with Fountain, users will be able to add it to their application workflows as a stage type. Fountain will send you applicants, you will do your work on those applicants, and then you send the results back to Fountain. Users will then see the results of your service in Fountain!

Integration Environments (Sandbox & Production)

During the integration process, you will receive two sets of API credentials. One for a sandbox environment and one for our production servers.

Sandbox: As part of your integration package, you will receive the web URL, login information, and API key for your sandbox environment URL. The sandbox environment also will be pre-populated with user and Applicant data and will allow you to simulate an Applicant landing on your Partner Stage and calling your service.

You'll be able to call back into the sandbox when you're finished and see the changes you've made reflect on the Applicant's profile.

Production: Once you have completed and tested your Partner integration, the Fountain team will review your integration for function and user friendliness. After this review is complete, we will activate your production integration and provide you the second API key for our production environment.

Updating Partner Integration Settings

Fountain Partner account settings are configured using our Partner API endpoints.

You can use these endpoints to view your API keys, define packages offered by your service, update status on your service, and setup your webhook URLs, and test your production and sandbox integrations.

Webhooks

Fountain's Partner API offers multiple webhooks to pass information between Fountain and your service.

• Install Webhook (optional): Triggers when your Partner Integration credentials (API Key and Account ID) are saved to a Customer account
• Applicant Webhook (required): Sends Fountain data to you whenever an applicant lands on your Partner Stage. If you require additional data beyond what is provided by default, please refer to this section on requesting additional data attributes.
• Settings Webhook (required): Loads your different service packages (Partner Stage Options) when your Partner Stage is loaded for the first time and whenever a user chooses to click Refresh Options within your Partner Stage
• Uninstall Webhook (optional): Triggers whenever your Partner Integration credentials is removed from a Fountain account

Built-in Retries

Fountain's webhooks will retry sending for 4xx or 5xx response status codes until we receive a 2xx response status code. After a certain number of retries, we consider the event as failed and stop re-retrying.

• We use Exponential Backoff Strategy meaning that Fountain will retry with increasing wait periods between attempts up to 20 times.
  • For a given failure to reach the final retry and thus stop making attempts would take ~2 weeks.

Fountain Callback

When you're done with processing an applicant, you must return your results to Fountain. This requires updating Partner Status, but you can optionally attach multiple Partner Details to an Applicant depending on the results of your work.

Refer to the API reference for documentation on updating Partner Status and Partner Details.

Updated 7 months ago