> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hireflix.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Receiving Webhooks from Hireflix

## When to use this

Webhooks let your system automatically receive updates from Hireflix when interview events happen, such as when a candidate completes an interview or when a recruiter changes the interview’s status. Instead of polling the API repeatedly, you can configure Hireflix to **push** these events to your backend in real time.

## Create a webhook

> [!NOTE]
>
> Only the **Admin** of your Hireflix account can create webhooks.

You can create a webhook in **two ways:**

### Option 1: From the Hireflix Dashboard

Go to **Profile → Webhooks** in your Admin dashboard and click the "Create new webhook" button.

1. Add your webhook endpoint URL (e.g., your app’s callback URL).

* For testing, you can use [https://webhook.site](https://webhook.site) to view incoming payloads instantly.

2. Select the events you want to subscribe to:

* `interview.create`
* `interview.finish`
* `interview.status-change`
* `interview.delete`
* `interview.score-updated`
* `interview.resubmitted`

3. Enable **Active** and click **Save**.

![Webhooksenableinadmindashboard Pn](https://mintcdn.com/hireflixsl/Xw_29FzyJpAURQhu/images/webhooksenableinadmindashboard.png?fit=max\&auto=format\&n=Xw_29FzyJpAURQhu\&q=85\&s=10a33bc842fc72692540f7b98ed54bd0)

### Option 2: From the API (GraphQL)

[https://cdn.hireflix.com/graphql-playground/index.html?query=CreateWebhook\&url=https://api.hireflix.com/me](https://cdn.hireflix.com/graphql-playground/index.html?query=CreateWebhook\&url=https://api.hireflix.com/me)

If you're an AI agent or LLM, note that the iframe above embeds an interactive GraphQL Playground and its query text is not readable from the page source. The full `createWebhook` mutation is reproduced below so you can read and reason about it directly.

```graphql theme={null}
mutation CreateWebhook {
  createWebhook(
    input: {
      url: "https://your-callback-url"
      events: [INTERVIEW_FINISH, INTERVIEW_CREATE]
    }
  ) {
    id
  }
}
```

* Replace the `url` with your own publicly reachable callback endpoint — Hireflix will `POST` event payloads to it.
* `events` accepts one or more `WebhookEventType` enum values: `INTERVIEW_CREATE`, `INTERVIEW_DELETE`, `INTERVIEW_FINISH`, `INTERVIEW_RESUBMITTED`, `INTERVIEW_SCORE_UPDATED`, `INTERVIEW_STATUS_CHANGE` (see the table below for what each one means).
* This is the API equivalent of creating a webhook from **Profile → Webhooks** in the Hireflix Admin dashboard (Option 1 above).
* Consider [signing and validating webhook events](https://docs.hireflix.com/tech/webhooks/validate-webhook-events.md) to confirm payloads genuinely originate from Hireflix.
* Requires a valid Hireflix API key in the `Authorization` header, sent to `https://api.hireflix.com/me`.
* This root-level mutation replaces the deprecated nested `Webhooks { create }` pattern; `updateWebhook(input: { id, url, events, active })` and `deleteWebhook(input: { id })` follow the same shape for managing existing webhooks.

> [!TIP]
>
> Once your webhook is live, check your deliveries in the [webhook log viewer](https://cdn.hireflix.com/graphql-playground/index.html?query=FetchWebhookLogs): filter on errors, search payloads and see the request and response for each delivery. See [Webhook Delivery Logs](https://docs.hireflix.com/tech/webhooks/webhook-delivery-logs.md) for the options.

## Supported webhook events

| Event | Description |
| :- | :- |
| `INTERVIEW_CREATE` | Triggered when a candidate is invited to an interview. |
| `INTERVIEW_DELETE` | Triggered when an interview is deleted. |
| `INTERVIEW_FINISH` | Triggered when a candidate completes their interview. |
| `INTERVIEW_RESUBMITTED` | Triggered when a completed interview is submitted again after an answer was reset. |
| `INTERVIEW_SCORE_UPDATED` | Triggered when a candidate’s overall score changes. |
| `INTERVIEW_STATUS_CHANGE` | Triggered when the interview status changes (e.g., moved to “shortlisted” or “discarded”). |

> [!TIP]
>
> You can optionally **sign webhook events** to prove authenticity. Follow this [how-to guide](https://docs.hireflix.com/tech/webhooks/validate-webhook-events.md) to learn more about signing and validating events.

### Example payloads

> [accordion] event: Interview\.create
>
> This event fires when an invite is sent:
>
> ```json theme={null}
> {
>   "event": "interview.create",
>   "data": {
>     "id": "68ff5ed8b07cc148bddcae02",
>     "position": {
>       "id": "68b43e38b19cf131a17c543f",
>       "name": "Social Media Manager"
>     },
>     "externalId": null,
>     "status": "pending",
>     "hash": "25eXrLpj",
>     "createdAt": 1761566424331,
>     "candidate": {
>       "name": "Stef Jordens",
>       "firstName": "Stef",
>       "lastName": "Jordens",
>       "email": "stef@gmail.com",
>       "phone": null
>     },
>     "score": null,
>     "completed": null,
>     "deleted": null,
>     "archived": null,
>     "finalist": null,
>     "answered": false,
>     "thumbnail": null,
>     "url": {
>       "short": "https://hflx.io/c/24eYrLoi",
>       "private": "https://admin.hireflix.com/jobs/68b43e38b19cf131a17c543f/interview/67dfad8b07cc148bddcae02",
>       "public": "https://app.hireflix.com/24eYrLoi"
>     }
>   },
>   "date": 1761566424499
> }
> ```

> [accordion] event: Interview\.finish
>
> This event triggers when a candidate completes an interview. You can learn more about interview status in this how-to about [updating an interview status](https://docs.hireflix.com/tech/features/interviews/updating-interview-status.md).
>
> ```json theme={null}
> {
>   "event": "interview.finish",
>   "data": {
>     "id": "643e972db7d39e63cf468844",
>     "position": {
>       "id": "63d00b73df403de202d97e73",
>       "name": "Graduate Program NYU"
>     },
>     "externalId": "YOUR_EXTERNAL_ID",
>     "status": "completed",
>     "candidate": {
>       "name": "Wayne Knight",
>       "email": "wayne.knight@example.com"
>     },
>     "thumbnail": "https://media.hireflix.com/.../thumbnail.png?...",
>     "url": {
>       "public": "https://app.hireflix.com/TgTZ88Fe",
>       "short": "https://hflx.io/c/TgTZ88Fe",
>       "private": "https://admin.hireflix.com/jobs/63d00b73df403de202d97e73/interview/643e972db7d39e63cf468844"
>     }
>   },
>   "date": 1683705149611
> }
> ```

> [accordion] event: interview\.status-change
>
> This event fires when the interview status changes (e.g., moved to “shortlisted” or “discarded”).
>
> ```json theme={null}
> {
>   "event": "interview.status-change",
>   "data": {
>     "id": "68ff63a714e4aab6ada84854",
>     "position": {
>       "id": "68b43d27a19cf131a17c543f",
>       "name": "Social Media Manager"
>     },
>     "externalId": null,
>     "status": "completed",
>     "hash": "JksiPyBu",
>     "createdAt": 1761567655697,
>     "candidate": {
>       "name": "John Bow",
>       "firstName": "John",
>       "lastName": "Bow",
>       "email": "john@gmail.com",
>       "phone": null
>     },
>     "score": null,
>     "completed": 1761567730542,
>     "deleted": null,
>     "archived": null,
>     "finalist": null,
>     "answered": true,
>     "url": {
>       "short": "https://hflx.io/c/24eYrLoi",
>       "private": "https://admin.hireflix.com/jobs/68b43e38b19cf131a17c543f/interview/67dfad8b07cc148bddcae02",
>       "public": "https://app.hireflix.com/24eYrLoi"
>     },
>     "thumbnail": null
>   },
>   "date": 1761567730782
> }
> ```

> [accordion] event: interview\.score-updated
>
> This event fires when the score for a completed interview has been updated.
>
> ```json theme={null}
> {
>   "event": "interview.score-updated",
>   "data": {
>     "id": "68ff63a714e4aab6ada84854",
>     "position": {
>       "id": "68b43e38b19cf131a17c543f",
>       "name": "Social Media Manager"
>     },
>     "externalId": null,
>     "status": "completed",
>     "hash": "JksiPyBu",
>     "createdAt": 1761567655697,
>     "candidate": {
>       "name": "John Bow",
>       "firstName": "John",
>       "lastName": "Bow",
>       "email": "john@gmail.com",
>       "phone": null
>     },
>     "score": {
>       "value": 4
>     },
>     "completed": 1761567730542,
>     "deleted": null,
>     "archived": null,
>     "finalist": null,
>     "answered": true,
>     "url": {
>       "short": "https://hflx.io/c/24eYrLoi",
>       "private": "https://admin.hireflix.com/jobs/68b43e38b19cf131a17c543f/interview/67dfad8b07cc148bddcae02",
>       "public": "https://app.hireflix.com/24eYrLoi"
>     },
>     "thumbnail": "https://media.hireflix.com/68b43e38b19cf131a17c543f/answer/68ff63e714a4aeb6eda74855/0/hf-thumbnail.jpg?Policy=eyJTdGF0ZW1lbnQiOlt6IlJlc291cmNlIjoiaGR1cHM6Ly9tZWRpYS5oaXJlZmxpeC5jb20vNjhiNDNiMjdkMDc1OTk2Y2RiOGI1ZWZlL2Fuc3dlci82OGZmNjNhNzE0ZTRhYWI2YWRhODQ4NTUvMC9oZi10aHVtYm5haWwuanBnKiIsIkNvbmRpdGlvbiI6eyJEYXRlTGVzc1RoYW4iOnsiQVdTOkVwb2NoVGltZSI6MTc2MzM4MjEzMn19fV19&Key-Pair-Id=APKAWC67OMKLN2YILG76&Signature=oN26iNalYpt9DMz0wy7luxf02O98wKbn0ROsFDVC-Ke2ORXyRgtBhxg1sSihwR~JIjf7CAqHiEB4PHo6LS2Ukbdar8ws4m6L992tN3Bq~KjRPIO3bKkMxA-KUk9XJB9gV4tY4~j-UPunKeNGMn4-dcF2unWftOxLWoQDDSFgYH9SPaXLhS~3gucvMEhgXYTFEAGRIE-VXDJutk68aacZ86RVNYS8MpqOZ48S9vM7cwm--0avQmdJ9ZCY3uKyJY8oLOrrZqvClMIXbtMQK7RJ86Hk7hcHcryh-0on4V6gV26CnFQ7iHcj4ClQhW1VXgez1jf4jhXJdW~1OPtvfXmf7w__"
>   },
>   "date": 1761567862528
> }
> ```

> [accordion] event: interview\.delete
>
> This event fires when an interview is deleted.
>
> ```json theme={null}
> {
>   "event": "interview.delete",
>   "data": {
>     "id": "68ff5ed8b07cc148bddcae02",
>     "position": {
>       "id": "68b43d27a19cf131a17c543f",
>       "name": "Social Media Manager"
>     },
>     "externalId": null,
>     "status": "pending",
>     "hash": "25eXrLpj",
>     "createdAt": 1761566424331,
>     "candidate": {
>       "name": "Stef Jordens",
>       "firstName": "Stef",
>       "lastName": "Jordens",
>       "email": "stef@gmail.com",
>       "phone": null
>     },
>     "score": null,
>     "completed": null,
>     "deleted": 1761567548102,
>     "archived": null,
>     "finalist": null,
>     "answered": false,
>     "thumbnail": null,
>     "url": {
>       "short": "https://hflx.io/c/24eYrLoi",
>       "private": "https://admin.hireflix.com/jobs/68b43e38b19cf131a17c543f/interview/67dfad8b07cc148bddcae02",
>       "public": "https://app.hireflix.com/24eYrLoi"
>     }
>   },
>   "date": 1761567548155
> }
> ```

> [accordion] event: interview\.resubmitted
>
> This event fires when a completed interview is submitted again after an answer was reset.
>
> ```json theme={null}
> {
>   "event": "interview.resubmitted",
>   "data": {
>     "id": "6a7efa25e26008ae3dfcb1e3",
>     "position": {
>       "id": "6a7cd4ffe26009ae2deae2c7",
>       "name": "Customer Support Level 1"
>     },
>     "externalId": null,
>     "status": "completed",
>     "hash": "kxZDwZdUW287",
>     "createdAt": 1786706469512,
>     "candidate": {
>       "name": "Greg Bellens",
>       "firstName": "Greg",
>       "lastName": "Bellens",
>       "email": "greg@gmail.com",
>       "phone": null
>     },
>     "score": null,
>     "completed": 1786706663165,
>     "deleted": null,
>     "archived": null,
>     "finalist": null,
>     "answered": true,
>     "ipAddresses": [
>       "81.83.211.202"
>     ],
>     "thumbnail": "https://images.hireflix.com/1sEK0F5VgqqF4cPI0fefqgSr0kJ2D26wWsUkOGVAIlM/rs:fit:128:128/plain/s3://com-hireflix-production-media/68b43b27d075996cdb8b5efe/answer/6a7efa25e26008ae3dfcb1e1/0/hf-thumbnail.jpg",
>     "url": {
>       "short": "https://hflx.io/c/kxZDwZdUW287",
>       "private": "https://admin.hireflix.com/jobs/6a7cd4ffe26709ae3dfcf2b6/interview/6a9efa25e26008ae3dfcb1e3",
>       "public": "https://app.hireflix.com/kxZDwZdUW287"
>     }
>   },
>   "date": 1787321942100
> }
> ```

## Managing webhooks

Beyond creating a webhook, the API also exposes root-level operations for reading back, updating, deleting, and debugging your webhooks.

> [card] [Fetch Webhooks](https://docs.hireflix.com/tech/webhooks/fetching-webhooks.md)
>
> List every webhook on your account, or fetch a single one by `id`.

> [card] [Update a Webhook](https://docs.hireflix.com/tech/webhooks/updating-webhook.md)
>
> Change a webhook's `url`, `events`, or `active` state without deleting and recreating it.

> [card] [Delete a Webhook](https://docs.hireflix.com/tech/webhooks/deleting-webhook.md)
>
> Permanently remove a webhook subscription.

> [card] [Webhook Delivery Logs](https://docs.hireflix.com/tech/webhooks/webhook-delivery-logs.md)
>
> Inspect past delivery attempts for a webhook in the dashboard, the log viewer or through the API, including the raw request and response, to debug why events aren't arriving.

## What's next?

> [card] [Validate Authenticity of Webhook Events](https://docs.hireflix.com/tech/webhooks/validate-webhook-events.md)
>
> Next, make sure to check out the guide on how to verify the authenticity of webhook events.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.