Zapier Integration

Automate reference checks with the HiveRef Zapier integration

HiveRef integrates with Zapier to automate your hiring workflows. Use the HiveRef Zapier app to send a reference request to a candidate automatically when they reach the reference stage in your hiring tool, trigger automations when reference checks are created or completed, and generate pre-filled reference check wizard links from candidate data in other tools.

Get your API key Request Zapier access

Section 1

Quick start

1Sign in to HiveRef, open Settings > API, and follow the setup card. Generate an API key and copy it.
2In Zapier, create a Zap and choose HiveRef as the trigger or action app.
3Paste your API key when Zapier asks you to connect HiveRef, then build your Zap.

Popular Zaps

Candidate reaches the reference stage in your hiring tool, then HiveRef sends them a request to add their referees.
New row in a Google Sheet, then a pre-filled HiveRef link is emailed to the hiring manager.
Reference check completed, then a message with the report link is posted in Slack or Teams.
Reference check completed, then the report link is added as a note on the candidate record.

Section 2

Authentication

HiveRef uses API key authentication. Generate your API key from your HiveRef dashboard under Settings > API.

Include your key in every request using the Authorization header:

Authorization: Bearer YOUR_API_KEY

Where to find your API key

Sign in to HiveRef and navigate to Settings > API. You can generate and rotate your key from there. Keep it secure and never share it publicly.

Section 3

Endpoints

All endpoints use the base URL https://www.hiveref.com and require a valid API key.

GEThttps://www.hiveref.com/api/zapier/me

Description

Verifies your API key and returns your organisation details.

Response

{
  "organisation_id": "string",
  "organisation_name": "string",
  "plan": "string"
}

POSThttps://www.hiveref.com/api/zapier/hooks

Description

Subscribes a Zapier webhook to receive events when a reference check is created or completed. The target_url must be a https://hooks.zapier.com or https://hook.<zone>.make.com address.

Request body

{
  "event_type": "check_completed" | "check_created",
  "target_url": "string"
}

Response

{
  "id": "string",
  "event_type": "string",
  "target_url": "string",
  "created_at": "string"
}

DELETEhttps://www.hiveref.com/api/zapier/hooks

Description

Unsubscribes a webhook.

Request body

{
  "id": "string"
}

POSThttps://www.hiveref.com/api/zapier/prefill

Description

Generates a pre-filled HiveRef reference check wizard URL from candidate details.

Request body

{
  "candidate_first_name": "string (required)",
  "candidate_last_name": "string (required)",
  "role_title": "string (required)",
  "candidate_email": "string (optional)"
}

Response

{
  "wizard_url": "string",
  "candidate_name": "string",
  "role_title": "string"
}

POSThttps://www.hiveref.com/api/zapier/checks

Description

Creates a reference check and emails the candidate a secure link to add their referees. Uses one reference check from your plan, trial or prepaid balance, the same as creating a check in HiveRef. Returns 403 with a clear message when your organisation has no checks left. Limited to 30 requests per minute per organisation.

Request body

{
  "candidate_first_name": "string (required)",
  "candidate_last_name": "string (required)",
  "candidate_email": "string (required)",
  "role_title": "string (required)",
  "target_referees_count": "integer 1 to 6 (optional, default 2)",
  "question_template_id": "string (optional, default hiveref-general)"
}

Response (201)

{
  "id": "string",
  "candidate_name": "string",
  "candidate_email": "string",
  "role_title": "string",
  "status": "invites_pending",
  "target_referees": 2,
  "question_template": "string",
  "created_at": "string",
  "organisation_id": "string",
  "check_url": "string"
}

GEThttps://www.hiveref.com/api/zapier/question-templates

Description

Lists the question templates you can use when sending a candidate request: HiveRef templates first, then your organisation's saved templates. Used to fill the Question Template dropdown in Zapier.

Response

[
  {
    "id": "string",
    "name": "string"
  }
]

GEThttps://www.hiveref.com/api/zapier/checks/recent

Description

Returns recent reference checks (newest first). Used by Zapier as the sample / polling list for the check created trigger.

Response

[
  {
    "id": "string",
    "candidate_name": "string",
    "candidate_email": "string",
    "role_title": "string",
    "status": "string",
    "created_at": "string",
    "organisation_id": "string",
    "check_url": "string"
  }
]

GEThttps://www.hiveref.com/api/zapier/checks/completed

Description

Returns completed reference checks (newest first). Used by Zapier as the sample / polling list for the check completed trigger.

Response

[
  {
    "id": "string",
    "candidate_name": "string",
    "candidate_email": "string",
    "role_title": "string",
    "completed_at": "string",
    "organisation_id": "string",
    "report_url": "string"
  }
]

Section 4

Trigger events

Subscribe to these events via the POST /api/zapier/hooks endpoint to receive webhook notifications.

check_completed

Fires when a reference check is completed and all referee responses have been collected.

Payload fields

idCheck ID
candidate_nameFull name of the candidate
candidate_emailCandidate email address
role_titleRole being hired for
completed_atISO timestamp of completion
organisation_idYour organisation ID
report_urlLink to the completed report in HiveRef

check_created

Fires when a new reference check is created.

Payload fields

idCheck ID
candidate_nameFull name of the candidate
candidate_emailCandidate email address
role_titleRole being hired for
statusInitial status (draft or invites_pending)
created_atISO timestamp of creation
organisation_idYour organisation ID
check_urlLink to the check in HiveRef

Section 5

Actions

Use these in the action step of a Zap.

Send Candidate Referee Request

Creates a reference check and emails the candidate a secure link to add their referees. Choose the number of referees and a question template, or leave them blank to use the defaults (2 referees, the HiveRef General template).

Uses one reference check from your plan, trial or prepaid balance. If your organisation has none left, nothing is created and Zapier shows a clear message.

Open Reference Check Wizard

Builds a link to the HiveRef wizard with the candidate's name, role and email already filled in. Share it with the hiring manager, who reviews and sends the check. This action does not create a check or use up any checks.

Ready to connect HiveRef to Zapier?

Generate your API key from your dashboard and connect HiveRef to thousands of apps in Zapier.

Get your API key Contact us