Configuration Requirements

As described in Configuring Your ATS as a User, your users will need to acquire a client_id and client_secret from their ZEIL company page. These values authenticate your users into the ZEIL ATS API.

Your ATS software will need a way to enter these values as configuration. They are issued per customer, so it should be a one-time setup, ideally by a system administrator.

How you choose to expose this to the user will be up to you and should match whatever design philosophy you current use for configuring your ATS software.

Verification and Initialisation

Once the user has entered their credentials, you'll need to perform a one-time call to our initialisation endpoint, /api/integration/setup.

This call completes two tasks. First, it verifies the credentials that your user entered and allows you to provide immediate feedback. Secondly, it contains a parameter that tells the ZEIL ATS API how to notify your system of candidate applications.

For candidate applications, there are two default methods as described in Receiving Candidate Applications:

1. ZEIL_CALLBACK will configure for a standard webhook callback.
2. ZEIL_EMAIL will configure for a standard notification email.

If you wish to use a different method, please feel free to contact us.