Skip to main content
Hireflix logo
  • Category: human resources
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 18
  • Triggers: 0
  • Slug: HIREFLIX
  • Version: 20261101_00

Tools

Slug: HIREFLIX_CREATE_CANDIDATE_INTERVIEWCreate a candidate interview in a Hireflix position without sending candidate notifications. This still creates a candidate and interview record.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_CREATE_POSITIONCreate 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

string
required
Position name, 1-50 characters after trimming.
array
Up to five tags, each 1-25 characters after trimming.
boolean
Whether the position is publicly discoverable. Defaults to false.
string
Optional company theme ID from List Themes.
array
required
One to 50 ordered video-answer questions.
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.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_DELETE_POSITIONPermanently 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

string
required
ID of the Hireflix position to permanently delete. This operation cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_GET_ACCOUNT_OVERVIEWReturn the connected Hireflix user, company, subscription status, permissions, and current usage counters without exposing credentials.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_GET_INTERVIEWReturn one accessible Hireflix interview with candidate, progress, answers, scores, comments, metadata, and sharing state.

Input Parameters

string
Optional external-system interview ID associated with this interview; omit when it is not needed for lookup.
string
required
Hireflix interview ID returned by List Position Interviews or Invite Candidate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_GET_POSITIONReturn one Hireflix position’s configuration and interview-step details by position ID; use List Position Interviews for candidates.

Input Parameters

string
required
Hireflix position ID returned by List Positions or Create Position.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_INVITE_CANDIDATEInvite a candidate to a Hireflix position with candidate notifications enabled. Notification delivery cannot be undone.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_LIST_NOTIFICATION_TEMPLATESList Hireflix notification templates for one channel without returning Draft.js message bodies.

Input Parameters

string ("EMAIL" | "SMS" | "WHATSAPP")
required
Notification channel whose templates to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_LIST_POSITION_INTERVIEWSReturn one cursor-controlled page of interviews for a Hireflix position, with optional candidate and stage filters.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_LIST_POSITIONSReturn all positions visible to the connected Hireflix account, including archive state and tags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_LIST_THEMESReturn the company’s available position branding themes and their core visual settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_LIST_WEBHOOKSReturn configured Hireflix webhook destinations, activation state, and subscribed events without exposing signing secrets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_SET_INTERVIEW_DECISIONMove a Hireflix interview to the shortlisted or discarded hiring stage.

Input Parameters

string ("SHORTLIST" | "DISCARD")
required
Hiring decision to apply to the interview.
string
required
Interview whose hiring decision stage to set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_SET_POSITION_ARCHIVEDArchive a Hireflix position to stop new submissions, or unarchive it to accept submissions again.

Input Parameters

boolean
required
True to archive and stop new submissions; false to unarchive and accept submissions again.
string
required
ID of the Hireflix position whose archive state to change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_SHARE_INTERVIEWCreate 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

array
Optional labels to apply to the shared interview.
string
required
Interview to expose through a public, unauthenticated share link.
integer
Number of days the public, unauthenticated link remains usable. Must be at least 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_UPDATE_INTERVIEW_REVIEWSet 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

number
Score from 0.5 through 5. Pass null explicitly to clear it; omit to leave it unchanged.
string
Comment text. Pass null explicitly to clear it; omit to leave it unchanged.
string
required
Interview to review.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_UPDATE_POSITIONPatch 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

string
New position name, from 1 to 50 characters. Omit to preserve it; null is not accepted.
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.
boolean
Whether the position is public. Omit to preserve it; null is not accepted.
string
Theme to assign. Omit to preserve the current theme; pass null explicitly to remove it.
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.
string
required
ID of the Hireflix position to update.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HIREFLIX_WHO_AM_IReturn the identity of the user associated with the connected API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not