Request REST API Credentials for the Bullhorn Extension Configuration Starter

Developers who build and deploy custom interactions in the Bullhorn ATS using the Extension Configuration Starter need REST API credentials before they can deploy their work. This article explains what credentials are needed, how to request them through Bullhorn Support, and what to expect after submitting a request.

Common Reasons You Might Need This Article

  • You are setting up the Bullhorn Extension Configuration Starter for the first time and need REST credentials to configure your environment files.

  • You cloned the Extension Configuration Starter project and the deploy script is failing because no Client ID or Client Secret is configured.

  • You are deploying interactions to a new environment (for example, staging or production) and need separate credentials for each.

  • You need to know what information to include in your support ticket to avoid delays in getting your credentials.

What the Extension Configuration Starter Requires

The Bullhorn Extension Configuration Starter is a template project that developers use to build and deploy Field and Page Interactions inside the Bullhorn ATS. To deploy interactions to any environment, the project requires a set of REST API credentials stored in its environment configuration files.

The required credentials are:

  • Client ID

  • Client Secret

  • API Username

  • API Password

These credentials are not self-service. A request must be submitted to Bullhorn Support to have them created.

How to Request REST API Credentials

To get credentials for the Extension Configuration Starter, submit a support ticket to Bullhorn Support. Include the following information in your ticket so Support can create your credentials without needing to follow up for missing details.

  1. Open a support ticket with Bullhorn Support.

  2. In your ticket, include the following:

    • That you are requesting OAuth credentials for use with the Extension Configuration Starter

    • Your developer contact name and email address (where the credentials should be sent)

    • The purpose of the credentials (Interactions Deployment via the Extension Configuration Starter)

    • The target environment (for example, Staging or Production)

  3. Submit the ticket and await confirmation from Support.

What Happens After You Submit Your Request

After you submit your ticket, Bullhorn Support will process your request and deliver your OAuth Client ID, Client Secret, and API Username through the support case. Before passing the credentials to your developer, you will need to generate a password for the API user. Allow a few business days for processing.

Configure Your Credentials in the Project

Once you receive your credentials, add them to the appropriate environment file inside the environments folder of your Extension Configuration Starter project.

  1. Open the environment file for your target environment (for example, environment.npe.json or environment.prod.json).

  2. Enter your API Username, Password, Client ID, and Client Secret in the corresponding fields.

  3. Save the file and proceed with your deploy script.

If your team uses additional environments beyond the default NPE and Production (Prod) configurations, create a new environment file following the same format and add your credentials there.

Troubleshooting

If your deploy script fails after entering credentials:

Verify that the credentials in your environment file exactly match what Support provided. Check for extra spaces, incorrect capitalization, or missing characters. If the credentials appear correct, follow up on your original support ticket to confirm that all processing steps have been completed on your key.

If you need credentials for multiple environments:

Submit a separate support ticket for each environment. Each environment requires its own Client ID and Client Secret.

If you are not sure which environment to request credentials for:

Start with your staging (NPE) environment for testing and submit a second request for production when you are ready to deploy.

FAQs

Can I use the same Client ID and Client Secret for both staging and production?

No. Each environment requires its own credentials. Submit a separate support ticket for each environment you plan to deploy to.

How long does it take to receive credentials after I submit a ticket?

Processing time varies. Support will create your OAuth credentials and complete an internal configuration step before your credentials are ready to use. If you have not received your credentials after a few business days, follow up on your original support ticket.

What is the redirect URI used for?

The redirect URI is a required part of the OAuth key configuration. For the Extension Configuration Starter, this value should always be set to https://welcome.bullhornstaffing.com/.

Can a third-party developer or partner request credentials on behalf of a client?

Yes. Include your developer contact information in the ticket. The credentials will be sent to the contact listed as the Owner's Email on the key request.

What happens if my Client Secret is compromised or I need to reset it?

Contact Bullhorn Support to request a new Client Secret. Do not commit credentials to source control or share them outside your team.