Teamtailor Partner API

To Create a Teamtailor Partner

1. Go to the Integration's Hub page by selecting the Settings option from the top-right corner.

2. To create a new partner, click on the Create A New Partner button.

3. Complete the New Partner's form by filling in the required fields: the Partner's name, base URL, and the category in the marketplace where you want your integration to be listed on Teamtailor's Marketplace page.

4. Click on the Show Advanced Settings to expand and fill in the following JSON into the Activation form field.

{
   "config":{
      "fields":[
         {
            "type":"infobox",
            "content":"<a href='https://hub.stackone.com/integration-configuration-concepts/ats/teamtailor-assessment-or-background-check'>Click</a> here to learn how to use this integration",
            "icon":"info"
         },
         {
            "id":"externalTriggerToken",
            "type":"password",
            "label":"External Trigger Token",
            "required":true,
            "description":"The token to be used to trigger the workflow externally"
         }
      ]
   }
}

This External Trigger Token field will be visible to the customer when enabling the integration from the Teamtailor Marketplace.

Upon saving, the partner integration will be successfully created.

To Get Partner Integration Credentials

1. On the Grid, next to your partner Integration’s name, you will find the Integration ID.

2. By clicking on Show Details, you can access the API Key.

To Enable and Connect the Integration

1. Navigate to the ATS category on the Integrations page and enable Teamtailor.

2. Please complete the necessary fields in the Teamtailor - Configuration model:
   • Authentication Type - Please select the Partner API or Public + Partner API to integrate with the Marketplace.
   • Partner Category - The selection is based on your Integration category on Teamtailor's Marketplace page. For example, if your integration is listed under the Assessments category, Please select Assessment from the dropdown.
   • Package's List Endpoint URL - The endpoint URL that StackOne will call to retrieve the list of packages when the recruiter wants to send the test to the candidate.
   • Partner Integration ID - You can find the Integration ID next to the Integration Name under Settings > Integration`s Hub in Teamtailor.
   • Partner Integration API Key - You can find an API key in the Integration details under Settings > Integration`s Hub in Teamtailor.
   • Package ID - If you don't have the Package List Endpoint URL, you can add a specific package ID that will be visible to the recruiter when they want to send the test to the candidate.

Click on the Confirmor Save Changes button to enable your Partner APIs, which allows end-users to link their accounts via the Hub.

What will the customer see?

When a customer enables Teamtailor from StackOne Hub, they will see the External Trigger Token used to enable the integration from the Teamtailor Marketplace.

What will the customer see after an assessment or background check has been sent?

When a customer sends an assessment to a candidate, they will see the success message on the candidate application pop-up.

How will the results of the assessment or background check be displayed to the customer?

When a customer opens a candidate application, they will see the updated result with their score from the previous success sent via webhook.