Skip to main content

​
Prerequisites

The connector should already be set up, with a Connector Profile and a Linked Account. See Getting Started on the Zinc connector page.

​
Receive Zinc status updates

Zinc has no webhook settings page. Instead, you attach a callback URL to each background-check request when you start it, and Zinc sends every status update for that request to that URL. Pass the StackOne Native Webhook URL of your linked account as that callback URL.

1

Retrieve StackOne Native Webhook URL

The Native Webhook URL is generated once an account has been linked. It is unique to that linked account, so keep it private.

  • Open the linked Zinc account in StackOne.
  • Copy the value from Native Webhook URL.
2

Enable the events on the connector profile

Events are only delivered to your StackOne webhook when they are turned on and routed in the connector profile.

  • Open the Zinc connector profile and open the Events tab.
  • Turn on the events you want to receive and select the StackOne webhook each one should be sent to.
  • Click Save Profile.
3

Send the URL when starting a check

When you start a background check, send the Native Webhook URL as resultsCallbackURL in the request body. Use the Start Check (Pre-Configured Package) or Start Check (Custom Package Specification) action, or the Zinc Partner API POST /checks request.

  • The callback URL applies to that one request only. Include it on every check you want status updates for.
  • Zinc also sends a cancellation update when the request is canceled in the Zinc web app.

​
Available webhook events

The following Zinc request events can be enabled. Only events turned on in StackOne are delivered to your StackOne webhook.

1

Review background check request events

Events for a background-check request, one per status the request moves to. Each event carries the request id, its status, its statusV2, any open actions, and the checks, result and reportUrl once they are available.

  • Request Paused (request.paused) — Fired when the request is paused until it is resumed
  • Request Awaiting Candidate (request.awaiting-candidate) — Fired when the candidate must complete a step before checks can continue
  • Request Attention Needed (request.attention-needed) — Fired when a recruiter action is required, such as an in-person identity verification listed in actions
  • Request In Progress (request.in-progress) — Fired when at least one check has progressed
  • Request Ready for Review (request.ready-for-review) — Fired when the screening outcome is ready for the recruiter to review
  • Request All Clear (request.all-clear) — Fired when all checks have completed with a clear outcome
  • Request Reviewed (request.reviewed) — Fired when the recruiter has completed the review of the outcome
  • Request Cancelled (request.cancelled) — Fired when the request is canceled, through the Partner API or in the Zinc web app

​
Delivery format

How Zinc delivers events to StackOne.

1

Inspect the request payload

Zinc sends one JSON body per status update, containing the current state of the whole request. StackOne routes each delivery on its statusV2 value to the matching event.

​
Verify

Your Connector should now be able to receive and process events. Try triggering an event and you should see an Event appear in the Connector logs.