API Reference

Redirecting Candidates after Screening

DigAI provides the ability to redirect candidates to a specific URL upon completion of a screening. Additionally, you can set a delay to allow candidates sufficient time to review their AI-generated feedback before the redirection takes place.

How to Configure Redirect Parameters

To utilize this feature, append two optional query parameters to your screening URL:

  • return_to: Specifies the URL to which the candidate will be redirected after viewing their feedback.
  • delay: Defines the number of seconds the candidate will remain on the feedback page before redirection.

Example URL Format

https://people.digai.ai/jy?id=<screeningId>&return_to=<REDIRECT_URL>&delay=<SECONDS>
  • Replace <screeningId> with your unique screening identifier.
  • Replace <REDIRECT_URL> with the full URL to which you want to redirect the candidate. You must add https:// to the url
  • Replace <SECONDS> with the desired delay duration (in seconds).

Delay Parameter Constraints

  • The maximum allowable delay is 300 seconds (5 minutes).
  • If the delay parameter is not provided, the default delay will be 30 seconds.

Allowed Domains for Redirection

To ensure security, the domain specified in the return_to parameter must be part of DigAI's allowed domain list. If the domain is not in the allowed list, the redirection will not occur. To add a domain to the allowed list, please contact DigAI's support team. This validation helps prevent candidates from being redirected to potentially malicious sites.

Example Usage

https://people.digai.ai/jy?id=1111-2222-3333-4444&return_to=https://digai.ai&delay=10

In this example:

  • Upon completion of the screening, the candidate will view their feedback.
  • After 10 seconds, the candidate will automatically be redirected to https://digai.ai.

Recommended Best Practices

  • Choose a delay long enough for the candidate to comfortably read and comprehend the provided feedback.
  • Clearly communicate to the candidate during the screening process that they will be redirected automatically, to avoid confusion or abrupt transitions.

This configuration enhances candidate experience by seamlessly guiding them to a relevant destination after they've interacted with DigAI’s intelligent feedback.