Skip to main content
This guide walks you through connecting your Carerix account with HireData. Follow the steps below to unlock the full potential of Carerix in your HireData automations. For visual support, watch the two step-by-step videos included. This is the standard and recommended way to connect Carerix with HireData. No manual configuration, client IDs, or secrets are required.

​
Before you begin, you’ll need

  • Access to your Carerix environment
  • Permission to install apps from the Marketplace

​
Step 1: Install Carerix RMA from the marketplace

1.1 Log in to your Carerix application Carerix login screen 1.2 Open the Marketplace Marketplace 1.3 Under New/Uninstalled, locate Carerix RMA (powered by HireData) Installing Carerix RMA 1.4 Click Install Install the app 1.5 After installation, the app will appear under Installed Carerix RMA installed

​
Step 2: Activate Carerix RMA

2.1 Go to the Installed tab in the Marketplace Installed Apps tab in Carerix 2.2 Find Carerix RMA Carerix RMA Installed 2.3 Fill in your settings, including:
  • Credit bundle
  • Additional brand(s)
  • Additional core app(s)
  • Additional WhatsApp number(s)
Credit bundle 2.4 Click Activate* to activate the app *In this screenshot, the Deactivate button is visible because the app is already active. Activate or Deactivate app button The Carerix RMA app depends on the Webhooks app. Carerix usually installs this dependency automatically during activation. If not, install the Webhooks app before activating the Carerix RMA. You should see a green checkmark next to the Carerix RMA and the Webhooks apps if both were installed correctly. Installed apps Watch the video tutorial for a full step-by-step guide on how to set up the connection:

​
Connecting multiple tenants (advanced setup)

If you need to connect more than one Carerix tenant to HireData (for example, a production and staging environment), you must use the legacy connection method inside HireData. This setup is intended for advanced use cases and is not required for single-tenant connections.

​
Step 1: Navigate to the Carerix app

Begin by navigating to the app section within HireData. Here, you’ll find the option to integrate with Carerix. This initial step is simple yet fundamental for the integration process.

​
Step 2: Configure your Carerix environment

To connect your Carerix and HireData environments, you need to (a) activate webhooks (see step 2.1) and (b) set up a client (see step 2.2). This gives you a (I) Client ID and (II) Client Secret for your Carerix environment. Follow the steps below to obtain those:

​
Step 2.1: Activate webhooks

First, you need to activate webhooks for your Carerix environment. To do this, send a support ticket to Carerix. Once Carerix activates webhooks, you can proceed to the next step. Some required scopes aren’t available until webhooks are activated.

​
Step 2.2: Set up a confidential client

Second, go to your Carerix environment and navigate to Maintenance > Identity Management > Clients. Click the New > Confidential link. Then fill in the following values:
  • Name: HireData
  • Code: urn:hiredata/hiredata
  • Default scopes:
    • urn:cx/cx5Wrapper:data:manage
    • urn:cx/webhooks:data:manage
  • Permissions:
    • Click Add and search for Webhooks
    • Configure permissions as follows:
      • create: on
      • delete: owner
      • read: all
      • update: owner
Last, click Save. Save your Client ID and Client Secret, especially the latter. Carerix only shows these values once for security reasons. If you don’t save them, you’ll have to redo this step. 2.2.1: Create a Confidential Client within Carerix Confidential Client within Carerix 2.2.2: Configure your Confidential Client within Carerix Configure Confidential Client 2.2.3: Copy your Client ID and Client Secret Client ID and Client Secret

​
Step 3: Create a new connection

Click + New Connection and enter the required Carerix details: your tenant (customer name or subdomain), Client ID, Client Secret, and API Key. If you don’t have a Client ID, Client Secret, and/or API Key yet, get in touch with your account manager at Carerix or contact Carerix’s support team. 3.1: Click + New Connection and start connecting your Carerix Adding New Connection 3.2: Provide your tenant (no capitals), client ID, and client secret to set up a new connection Enter Tenant, Client ID and Client Secret

​
Step 4: Carerix connected

After you’ve clicked Connect, you’ve finished setting up the connection between Carerix and HireData. When it’s the first time you’ve set up this connection, HireData might need a few minutes to sync data from your Carerix database. After that, you’re all set to set up your first Carerix automation in HireData. Watch the video tutorial for a full step-by-step guide on how to set up the connection:

​
Next step: Creating a Carerix automation in HireData

Now that you’ve set up the connection with Carerix, create your first Carerix automation within HireData.