Zapier Integration

HiveRef Zapier Integration

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

Get your API key Open in Zapier

Section 1

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 2

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.

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 (required)"
}

Response

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

Section 3

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

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