Cmdlets for Bullhorn CRM

Build 24.0.9060

Establishing a Connection

With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our BullhornCRM Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

Installing and Connecting

If you have PSGet, installing the cmdlets can be accomplished from the PowerShell Gallery with the following command. You can also obtain a setup from the CData site. 

Install-Module BullhornCRMCmdlets

The following line is then added to your profile, loading the cmdlets on the next session: 

Import-Module BullhornCRMCmdlets;

You can then use the Connect-BullhornCRM cmdlet to create a connection object that can be passed to other cmdlets: 

$conn = Connect-BullhornCRM -DataCenterCode "CLS33" -InitiateOAuth "GETANDREFRESH"

Pre-connection Requirements

Unlike many other data sources, Bullhorn CRM doesn't allow users to create their own custom OAuth applications or edit their CallbackURL directly. Instead, you must contact Bullhorn CRM and request that they create or change your OAuth application credentials (Client Id and Client Secret).

Bullhorn CRM also provides or updates your CallbackURL as needed. However, since waiting for a new CallbackURL from Bullhorn CRM may be a time-consuming process, we recommended that you consider using an OAuth verifier code to connect instead of a CallbackURL. Once Bullhorn CRM has provided your OAuth credentials, you can use them to authenticate your application.

Connecting to Bullhorn CRM

You'll need your username and password to authenticate and access your account. Follow these steps to ensure a successful connection:

  1. Use your account credentials to log in to your Bullhorn CRM account.
  2. Set the DataCenterCode in your application settings to the code that corresponds to your data center. For a full list of data center codes, refer to the list here.

Notes:

  • If you are uncertain about your data center code, note that codes like CLS2, CLS21, etc. are cluster IDs that are visible in the URL in your browser's address bar once you are logged in. For example, https://cls21.bullhornstaffing.com/BullhornSTAFFING/MainFrame.jsp?#no-ba... indicates that the logged-in user is associated with data center CLS21.
  • If you specify a CallbackURL such as http://localhost:33333/, ensure it is exactly the same as what you specify in your application settings. This includes any trailing slashes ("/"). Any addition or removal of characters from this URL will result in an error.

Authenticating to Bullhorn CRM (OAuth)

Bullhorn CRM supports OAuth authentication only. Unlike many other data sources, Bullhorn CRM doesn't allow users to create their own custom OAuth applications or edit their CallbackURL directly. Instead, you must request Bullhorn CRM to set up a custom OAuth application for you. This involves contacting Bullhorn CRM support to initiate the setup process. For information about how to create a custom OAuth application for Bullhorn CRM, see Creating a Custom OAuth Application.

The following subsections describe how to authenticate to Bullhorn CRM from three common authentication flows.

For a complete list of connection string properties available in Bullhorn CRM, see Connection.

Desktop Applications

To authenticate your desktop application, use one of the following options: using a verifier code or a custom CallbackURL. While using a custom CallbackURL is more straightforward, it requires you to contact Bullhorn CRM directly to request changes to it, which can be a time-consuming process. Therefore, we highly recommend using a verifier code instead. Although the setup is slightly more involved, it streamlines the authentication process.

Option 1: Using a verifier code

To start the authentication process with a verifier code, construct your authorization URL. This URL is what triggers the OAuth process where the output generates a unique code, which is essential for obtaining access tokens that enable secure interactions between your application and Bullhorn CRM.

Retrieving an OAuth verifier code

  1. Construct your Authorization URL as follows: https://<authorization URL for your data center>/oauth/authorize?client_id=<your OAuth Client Id>&response_type=code
    • For example, if you have data center "CLS40", the URL used for authentication is: https://auth-east.bullhornstaffing.com/oauth/authorize?client_id=<your OAuth Client Id>&response_type=code
    • Refer to the list here to find the authorization URL specific to your data center code.
  2. Next, open your authorization URL in a browser.
  3. Log in and grant permissions to the cmdlet. You are redirected to the CallbackURL, which contains the verifier code. The URL format is: https://www.bullhorn.com/?code=<verifiercode>&client_id=<clientid>
  4. Save the value of the verifier code directly from the URL.

Get and refresh the OAuth access token

Once you have retrieved the OAuth verifier code, the next step is to use it to obtain and manage your OAuth access token. This token allows your application to authenticate and interact securely with Bullhorn CRM. Configure the folllwing settings:

  • OAuthVerifier: The OAuth verifier code.
  • DataCenterCode: The data center your account is connected with. Find the list of the data centers here.
  • OAuthClientId: The Client Id that was assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The Client Secret that was assigned when you registered your custom OAuth application.
  • CallbackURL: The redirect URI that was defined when you registered your custom OAuth application.

Option 2: Using a custom CallbackURL

If you prefer using a CallbackURL (for example, http://localhost:33333), contact Bullhorn CRM and request that they configure your chosen URL as the authorized endpoint for OAuth callbacks. Once Bullhorn CRM confirms that your CallbackURL is set up, proceed to configure your application with the following settings:

  • CallbackURL: The custom CallbackURL provided by Bullhorn CRM.
  • DataCenterCode: The data center your account is connected with. Find the list of the data centers here.
  • OAuthClientId: The Client Id that was assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The Client Secret that was assigned when you registered your custom OAuth application.

Headless Machines

If you need to log in to a resource that resides on a headless machine, you must authenticate on another device that has an internet browser. You can do this in either of the following ways:

  • Option 1: Obtain the OAuthVerifier code.
  • Option 2: Install the cmdlet on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.

After you execute either Option 1 or Option 2, configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtaining and Exchanging a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL as follows:

  1. Authenticate from the machine with an internet browser, and obtain the OAuthVerifier connection property.

    Set these properties:

    • OAuthClientId: The Client Id assigned when you registered your custom OAuth application.
    • OAuthClientSecret: The Client Secret assigned when you registered your custom OAuth application.
    • DataCenterCode: The data center your account is connected with. Find the list of the data centers here.

  2. Call the GetOAuthAuthorizationURL stored procedure. The stored procedure returns the CallbackURL established when the custom OAuth application was registered. (See Creating a Custom OAuth Application.) Copy this URL and paste it into a new browser tab.
  3. Log in and grant permissions to the cmdlet. The OAuth application redirects you the redirect URI, with a parameter called code appended. Note the value of this parameter; you will need it later to configure the OAuthVerifier connection property.
  4. Call the GetOAuthAccessToken stored procedure and save the REST URL. You will set this in the RestUrl property.
  5. Exchange the OAuth verifier code for OAuth refresh and access tokens.

    On the headless machine, to obtain the OAuth authentication values, set these properties:

    • OAuthVerifier: The noted verifier code (the value of the code parameter in the redirect URI).
    • OAuthSettingsLocation: Persist the encrypted OAuth authentication values to the specified file.
    • OAuthClientId: The Client Id in your custom OAuth application settings.
    • OAuthClientSecret: The Client Secret in the custom OAuth application settings.
    • RestUrl: The URL returned by the GetOAuthAccessToken stored procedure.
    • DataCenterCode: The data center your account is connected with. Find the list of the data centers here.

  6. Test the connection to generate the OAuth settings file.
  7. You are ready to connect after you re-set these properties:
    • OAuthSettingsLocation: The file containing the encrypted OAuth authentication values. To enable the automatic refreshing of the access token, be sure that this file gives read and write permissions to the cmdlet.
    • OAuthClientId: The Client Id assigned when you registered your custom OAuth application.
    • OAuthClientSecret: The Client Secret assigned when you registered your custom OAuth application.
    • RestUrl: The URL returned by the GetOAuthAccessToken stored procedure.
    • DataCenterCode: The data center your account is connected with. Find the list of the data centers here.

Option 2: Transferring OAuth Settings

Prior to connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described above in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set these connection properties:

  • OAuthSettingsLocation: The path to the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the cmdlet.
  • OAuthClientId: The Client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The Client Secret assigned when you registered your custom OAuth application.
  • RestUrl: The URL returned by the GetOAuthAccessToken stored procedure.
  • DataCenterCode: The data center your account is connected with. Find the list of the data centers here.

Retrieving Data

The Select-BullhornCRM cmdlet provides a native PowerShell interface for retrieving data: 

$results = Select-BullhornCRM -Connection $conn -Table "Candidate" -Columns @("Id, CandidateName") -Where "CandidateName='Bob'"
The Invoke-BullhornCRM cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file: 

Select-BullhornCRM -Connection $conn -Table Candidate -Where "CandidateName = 'Bob'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCandidateData.csv -NoTypeInformation

You will notice that we piped the results from Select-BullhornCRM into a Select-Object cmdlet and excluded some properties before piping them into an Export-CSV cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each row object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON: 

 
PS C:\> $conn  = Connect-BullhornCRM -DataCenterCode "CLS33" -InitiateOAuth "GETANDREFRESH"
PS C:\> $row = Select-BullhornCRM -Connection $conn -Table "Candidate" -Columns (Id, CandidateName) -Where "CandidateName = 'Bob'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Candidate",
  "Columns":  [

  ],
  "Id":  "MyId",
  "CandidateName":  "MyCandidateName"
}

Deleting Data

The following line deletes any records that match the criteria: 

Select-BullhornCRM -Connection $conn -Table Candidate -Where "CandidateName = 'Bob'" | Remove-BullhornCRM

Modifying Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Bullhorn CRM, checking first whether a record already exists and needs to be updated instead of inserted. 

Import-Csv -Path C:\MyCandidateUpdates.csv | %{
  $record = Select-BullhornCRM -Connection $conn -Table Candidate -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-BullhornCRM -Connection $conn -Table Candidate -Columns @("Id","CandidateName") -Values @($_.Id, $_.CandidateName) -Where "Id  = `'$_.Id`'"
  }else{
    Add-BullhornCRM -Connection $conn -Table Candidate -Columns @("Id","CandidateName") -Values @($_.Id, $_.CandidateName)
  }
}

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060