---
canonical_url: "https://docs.composio.dev/toolkits/hireflix"
markdown_url: "https://docs.composio.dev/toolkits/hireflix.md"
product: "platform"
version: null
last_updated: null
---

# Hireflix

Hireflix is a one-way video interview platform for managing positions, candidate interviews, templates, themes, and hiring workflows.

- **Category:** human resources
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 18
- **Triggers:** 0
- **Slug:** `HIREFLIX`
- **Version:** 20260923_00

## Tools

### Create Candidate Interview

**Slug:** `HIREFLIX_CREATE_CANDIDATE_INTERVIEW`

Create a candidate interview in a Hireflix position without sending candidate notifications. This still creates a candidate and interview record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Candidate email, unique within the position. |
| `phone` | string | No | Optional valid mobile phone number. Hireflix may ignore invalid or landline values. |
| `metadata` | object | No | Optional JSON sync metadata with at most 25 keys and three object or array nesting levels. |
| `last_name` | string | No | Candidate last name, from 1 to 50 characters after trimming. |
| `first_name` | string | Yes | Candidate first name, from 1 to 50 characters after trimming. |
| `external_id` | string | No | Optional external-system ID, up to 255 characters. |
| `position_id` | string | Yes | Position to which the candidate will be invited. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Position

**Slug:** `HIREFLIX_CREATE_POSITION`

Create a one-way interview position with one or more video-answer questions. Positions are private by default; setting public=true makes the position publicly discoverable. Empty notification arrays request no custom configurations, but Hireflix may apply account defaults. Use Create Candidate Interview to add a candidate without sending; Invite Candidate sends configured notifications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Position name, 1-50 characters after trimming. |
| `tags` | array | No | Up to five tags, each 1-25 characters after trimming. |
| `public` | boolean | No | Whether the position is publicly discoverable. Defaults to false. |
| `theme_id` | string | No | Optional company theme ID from List Themes. |
| `questions` | array | Yes | One to 50 ordered video-answer questions. |
| `internal_notifications` | array | No | Custom internal notification configurations to request. An empty list requests none, but Hireflix may apply account defaults; creating a position does not itself deliver a notification. |
| `transcription_language` | string ("Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "Armenian" | "Assamese" | "AustralianEnglish" | "Azerbaijani" | "Bashkir" | "Basque" | "Belarusian" | "Bengali" | "Bosnian" | "Breton" | "BritishEnglish" | "Bulgarian" | "Burmese" | "Catalan" | "Chinese" | "Croatian" | "Czech" | "Danish" | "Dutch" | "Estonian" | "Faroese" | "Finnish" | "French" | "Galician" | "Georgian" | "German" | "GlobalEnglish" | "Greek" | "Gujarati" | "Haitian" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Icelandic" | "Indonesian" | "Italian" | "Japanese" | "Javanese" | "Kannada" | "Kazakh" | "Khmer" | "Korean" | "Lao" | "Latin" | "Latvian" | "Lingala" | "Lithuanian" | "Luxembourgish" | "Macedonian" | "Malagasy" | "Malay" | "Malayalam" | "Maltese" | "Maori" | "Marathi" | "Mongolian" | "Nepali" | "Norwegian" | "NorwegianNynorsk" | "Occitan" | "Panjabi" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "Romanian" | "Russian" | "Sanskrit" | "Serbian" | "Shona" | "Sindhi" | "Sinhala" | "Slovak" | "Slovenian" | "Somali" | "Spanish" | "Sundanese" | "Swahili" | "Swedish" | "Tagalog" | "Tajik" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "Turkish" | "Turkmen" | "USEnglish" | "Ukrainian" | "Urdu" | "Uzbek" | "Vietnamese" | "Welsh" | "Yiddish" | "Yoruba") | No | Optional Hireflix TranscriptionSupportedLanguage enum value; omit for automatic detection. Use a value returned by Hireflix's supported-language contract, such as USEnglish, BritishEnglish, Spanish, or French. |
| `candidate_notifications` | array | No | Custom candidate notification configurations to request. An empty list requests none, but Hireflix may apply account defaults. Delivery is only relevant when adding a candidate: Create Candidate Interview suppresses delivery, while Invite Candidate sends configured notifications. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Permanently Delete Position

**Slug:** `HIREFLIX_DELETE_POSITION`

Permanently delete a Hireflix position and its associated workflow state. This destructive operation cannot be undone. Use only a position ID that the caller explicitly intends to remove.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `position_id` | string | Yes | ID of the Hireflix position to permanently delete. This operation cannot be undone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Overview

**Slug:** `HIREFLIX_GET_ACCOUNT_OVERVIEW`

Return the connected Hireflix user, company, subscription status, permissions, and current usage counters without exposing credentials.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Interview

**Slug:** `HIREFLIX_GET_INTERVIEW`

Return one accessible Hireflix interview with candidate, progress, answers, scores, comments, metadata, and sharing state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `external_id` | string | No | Optional external-system interview ID associated with this interview; omit when it is not needed for lookup. |
| `interview_id` | string | Yes | Hireflix interview ID returned by List Position Interviews or Invite Candidate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Position

**Slug:** `HIREFLIX_GET_POSITION`

Return one Hireflix position's configuration and interview-step details by position ID; use List Position Interviews for candidates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `position_id` | string | Yes | Hireflix position ID returned by List Positions or Create Position. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Invite Candidate

**Slug:** `HIREFLIX_INVITE_CANDIDATE`

Invite a candidate to a Hireflix position and immediately send any configured candidate notifications. Notification delivery cannot be undone; use Create Candidate Interview to create the record without sending.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Candidate email, unique within the position. |
| `phone` | string | No | Optional valid mobile phone number. Hireflix may ignore invalid or landline values. |
| `metadata` | object | No | Optional JSON sync metadata with at most 25 keys and three object or array nesting levels. |
| `last_name` | string | No | Candidate last name, from 1 to 50 characters after trimming. |
| `first_name` | string | Yes | Candidate first name, from 1 to 50 characters after trimming. |
| `external_id` | string | No | Optional external-system ID, up to 255 characters. |
| `position_id` | string | Yes | Position to which the candidate will be invited. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notification Templates

**Slug:** `HIREFLIX_LIST_NOTIFICATION_TEMPLATES`

List Hireflix notification templates for one channel without returning Draft.js message bodies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel` | string ("EMAIL" | "SMS" | "WHATSAPP") | Yes | Notification channel whose templates to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Position Interviews

**Slug:** `HIREFLIX_LIST_POSITION_INTERVIEWS`

Return one cursor-controlled page of interviews for a Hireflix position, with optional candidate and stage filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum interviews to request for this page; Hireflix publishes no maximum. |
| `stage` | string ("discarded" | "pending" | "shortlisted" | "to_evaluate") | No | Optional Hireflix interview stage to match exactly. |
| `search` | string | No | Optional candidate name, email, or phone search text. |
| `direction` | string ("FORWARD" | "BACKWARD") | No | Direction in which to traverse the interview cursor. |
| `next_cursor` | string | No | Opaque lastCursor returned by the previous page; omit for the first page. |
| `position_id` | string | Yes | Position whose interviews to list. |
| `sort_direction` | string ("ASC" | "DESC") | No | Sort interviews by creation time ascending or descending. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Positions

**Slug:** `HIREFLIX_LIST_POSITIONS`

Return all positions visible to the connected Hireflix account, including archive state and tags.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Themes

**Slug:** `HIREFLIX_LIST_THEMES`

Return the company's available position branding themes and their core visual settings.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `HIREFLIX_LIST_WEBHOOKS`

Return configured Hireflix webhook destinations, activation state, and subscribed events without exposing signing secrets.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Interview Decision

**Slug:** `HIREFLIX_SET_INTERVIEW_DECISION`

Move a Hireflix interview to the shortlisted or discarded hiring stage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `decision` | string ("SHORTLIST" | "DISCARD") | Yes | Hiring decision to apply to the interview. |
| `interview_id` | string | Yes | Interview whose hiring decision stage to set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Position Archived

**Slug:** `HIREFLIX_SET_POSITION_ARCHIVED`

Archive a Hireflix position to stop new submissions, or unarchive it to accept submissions again.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `archived` | boolean | Yes | True to archive and stop new submissions; false to unarchive and accept submissions again. |
| `position_id` | string | Yes | ID of the Hireflix position whose archive state to change. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Share Interview

**Slug:** `HIREFLIX_SHARE_INTERVIEW`

Create an immediately active public, unauthenticated link exposing a Hireflix interview and its answers for duration_days (default 75). This toolkit cannot revoke the link before expiry, so treat sharing as irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `labels` | array | No | Optional labels to apply to the shared interview. |
| `interview_id` | string | Yes | Interview to expose through a public, unauthenticated share link. |
| `duration_days` | integer | No | Number of days the public, unauthenticated link remains usable. Must be at least 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Interview Review

**Slug:** `HIREFLIX_UPDATE_INTERVIEW_REVIEW`

Set or clear exactly one review field for a Hireflix interview: the connected user's score or comment. Pass null to clear the selected field; use a separate call for the other field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `score` | number | No | Score from 0.5 through 5. Pass null explicitly to clear it; omit to leave it unchanged. |
| `comment` | string | No | Comment text. Pass null explicitly to clear it; omit to leave it unchanged. |
| `interview_id` | string | Yes | Interview to review. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Position

**Slug:** `HIREFLIX_UPDATE_POSITION`

Patch a Hireflix position's core settings. Omitted fields are preserved. Null clears theme or restores automatic transcription language; use [] to clear tags. Supplied tag and question arrays replace existing values rather than merging.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New position name, from 1 to 50 characters. Omit to preserve it; null is not accepted. |
| `tags` | array | No | Complete replacement tag list of up to five values, each 1-25 characters. Omit to preserve tags; pass [] to clear them; null is not accepted. |
| `public` | boolean | No | Whether the position is public. Omit to preserve it; null is not accepted. |
| `theme_id` | string | No | Theme to assign. Omit to preserve the current theme; pass null explicitly to remove it. |
| `questions` | array | No | Complete replacement list of one to 50 ordered video-answer questions. Omit to preserve existing steps; supplied arrays replace rather than merge; null is not accepted. |
| `position_id` | string | Yes | ID of the Hireflix position to update. |
| `transcription_language` | string ("Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "Armenian" | "Assamese" | "AustralianEnglish" | "Azerbaijani" | "Bashkir" | "Basque" | "Belarusian" | "Bengali" | "Bosnian" | "Breton" | "BritishEnglish" | "Bulgarian" | "Burmese" | "Catalan" | "Chinese" | "Croatian" | "Czech" | "Danish" | "Dutch" | "Estonian" | "Faroese" | "Finnish" | "French" | "Galician" | "Georgian" | "German" | "GlobalEnglish" | "Greek" | "Gujarati" | "Haitian" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Icelandic" | "Indonesian" | "Italian" | "Japanese" | "Javanese" | "Kannada" | "Kazakh" | "Khmer" | "Korean" | "Lao" | "Latin" | "Latvian" | "Lingala" | "Lithuanian" | "Luxembourgish" | "Macedonian" | "Malagasy" | "Malay" | "Malayalam" | "Maltese" | "Maori" | "Marathi" | "Mongolian" | "Nepali" | "Norwegian" | "NorwegianNynorsk" | "Occitan" | "Panjabi" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "Romanian" | "Russian" | "Sanskrit" | "Serbian" | "Shona" | "Sindhi" | "Sinhala" | "Slovak" | "Slovenian" | "Somali" | "Spanish" | "Sundanese" | "Swahili" | "Swedish" | "Tagalog" | "Tajik" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "Turkish" | "Turkmen" | "USEnglish" | "Ukrainian" | "Urdu" | "Uzbek" | "Vietnamese" | "Welsh" | "Yiddish" | "Yoruba") | No | Hireflix TranscriptionSupportedLanguage enum value, such as USEnglish, BritishEnglish, Spanish, or French. Omit to preserve the setting; pass null explicitly to restore automatic detection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Who Am I

**Slug:** `HIREFLIX_WHO_AM_I`

Return the identity of the user associated with the connected API key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |