> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Hireflix

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

![Hireflix logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/hireflix.svg?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=89e28d2973db9311f028591cac3a017c)

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

## Tools

> [accordion] 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
>
> **email** `string` *required*
>
> Candidate email, unique within the position.
>
> **phone** `string`
>
> Optional valid mobile phone number. Hireflix may ignore invalid or landline values.
>
> **metadata** `object`
>
> Optional JSON sync metadata with at most 25 keys and three object or array nesting levels.
>
> **last\_name** `string`
>
> Candidate last name, from 1 to 50 characters after trimming.
>
> **first\_name** `string` *required*
>
> Candidate first name, from 1 to 50 characters after trimming.
>
> **external\_id** `string`
>
> Optional external-system ID, up to 255 characters.
>
> **position\_id** `string` *required*
>
> Position to which the candidate will be invited.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> Position name, 1-50 characters after trimming.
>
> **tags** `array`
>
> Up to five tags, each 1-25 characters after trimming.
>
> **public** `boolean`
>
> Whether the position is publicly discoverable. Defaults to false.
>
> **theme\_id** `string`
>
> Optional company theme ID from List Themes.
>
> **questions** `array` *required*
>
> One to 50 ordered video-answer questions.
>
> **internal\_notifications** `array`
>
> 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")`
>
> 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`
>
> 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **position\_id** `string` *required*
>
> ID of the Hireflix position to permanently delete. This operation cannot be undone.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Interview
>
> **Slug:** `HIREFLIX_GET_INTERVIEW`
>
> Return one accessible Hireflix interview with candidate, progress, answers, scores, comments, metadata, and sharing state.
>
> #### Input Parameters
>
> **external\_id** `string`
>
> Optional external-system interview ID associated with this interview; omit when it is not needed for lookup.
>
> **interview\_id** `string` *required*
>
> Hireflix interview ID returned by List Position Interviews or Invite Candidate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **position\_id** `string` *required*
>
> Hireflix position ID returned by List Positions or Create Position.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Invite Candidate
>
> **Slug:** `HIREFLIX_INVITE_CANDIDATE`
>
> Invite a candidate to a Hireflix position with candidate notifications enabled. Notification delivery cannot be undone.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Candidate email, unique within the position.
>
> **phone** `string`
>
> Optional valid mobile phone number. Hireflix may ignore invalid or landline values.
>
> **metadata** `object`
>
> Optional JSON sync metadata with at most 25 keys and three object or array nesting levels.
>
> **last\_name** `string`
>
> Candidate last name, from 1 to 50 characters after trimming.
>
> **first\_name** `string` *required*
>
> Candidate first name, from 1 to 50 characters after trimming.
>
> **external\_id** `string`
>
> Optional external-system ID, up to 255 characters.
>
> **position\_id** `string` *required*
>
> Position to which the candidate will be invited.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Notification Templates
>
> **Slug:** `HIREFLIX_LIST_NOTIFICATION_TEMPLATES`
>
> List Hireflix notification templates for one channel without returning Draft.js message bodies.
>
> #### Input Parameters
>
> **channel** `string ("EMAIL" | "SMS" | "WHATSAPP")` *required*
>
> Notification channel whose templates to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum interviews to request for this page; Hireflix publishes no maximum.
>
> **stage** `string ("discarded" | "pending" | "shortlisted" | "to_evaluate")`
>
> Optional Hireflix interview stage to match exactly.
>
> **search** `string`
>
> Optional candidate name, email, or phone search text.
>
> **direction** `string ("FORWARD" | "BACKWARD")`
>
> Direction in which to traverse the interview cursor.
>
> **next\_cursor** `string`
>
> Opaque lastCursor returned by the previous page; omit for the first page.
>
> **position\_id** `string` *required*
>
> Position whose interviews to list.
>
> **sort\_direction** `string ("ASC" | "DESC")`
>
> Sort interviews by creation time ascending or descending.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Positions
>
> **Slug:** `HIREFLIX_LIST_POSITIONS`
>
> Return all positions visible to the connected Hireflix account, including archive state and tags.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Themes
>
> **Slug:** `HIREFLIX_LIST_THEMES`
>
> Return the company's available position branding themes and their core visual settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhooks
>
> **Slug:** `HIREFLIX_LIST_WEBHOOKS`
>
> Return configured Hireflix webhook destinations, activation state, and subscribed events without exposing signing secrets.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Interview Decision
>
> **Slug:** `HIREFLIX_SET_INTERVIEW_DECISION`
>
> Move a Hireflix interview to the shortlisted or discarded hiring stage.
>
> #### Input Parameters
>
> **decision** `string ("SHORTLIST" | "DISCARD")` *required*
>
> Hiring decision to apply to the interview.
>
> **interview\_id** `string` *required*
>
> Interview whose hiring decision stage to set.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **archived** `boolean` *required*
>
> True to archive and stop new submissions; false to unarchive and accept submissions again.
>
> **position\_id** `string` *required*
>
> ID of the Hireflix position whose archive state to change.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **labels** `array`
>
> Optional labels to apply to the shared interview.
>
> **interview\_id** `string` *required*
>
> Interview to expose through a public, unauthenticated share link.
>
> **duration\_days** `integer`
>
> Number of days the public, unauthenticated link remains usable. Must be at least 1.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **score** `number`
>
> Score from 0.5 through 5. Pass null explicitly to clear it; omit to leave it unchanged.
>
> **comment** `string`
>
> Comment text. Pass null explicitly to clear it; omit to leave it unchanged.
>
> **interview\_id** `string` *required*
>
> Interview to review.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string`
>
> New position name, from 1 to 50 characters. Omit to preserve it; null is not accepted.
>
> **tags** `array`
>
> 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`
>
> Whether the position is public. Omit to preserve it; null is not accepted.
>
> **theme\_id** `string`
>
> Theme to assign. Omit to preserve the current theme; pass null explicitly to remove it.
>
> **questions** `array`
>
> 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` *required*
>
> 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")`
>
> Hireflix TranscriptionSupportedLanguage enum value, such as USEnglish, BritishEnglish, Spanish, or French. Omit to preserve the setting; pass null explicitly to restore automatic detection.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Who Am I
>
> **Slug:** `HIREFLIX_WHO_AM_I`
>
> Return the identity of the user associated with the connected API key.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
