Skip to main content
Breezy Hr logo
  • Category: hr talent & recruitment
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 48
  • Triggers: 0
  • Slug: BREEZY_HR
  • Version: 20261101_00

Tools

Slug: BREEZY_HR_ADD_CANDIDATE_CUSTOM_ATTRIBUTEAdd or update a custom attribute for a candidate on a position in Breezy HR. An existing attribute is matched by both its name and secure flag.

Input Parameters

string
required
The name/key of the custom attribute.
string
required
The value to assign to the custom attribute.
boolean
Whether this value needs to be encrypted at rest. Defaults to false.
string
required
The unique identifier of the company in Breezy HR.
string
required
The unique identifier of the position (job posting).
string
required
The unique identifier of the 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: BREEZY_HR_ADD_CANDIDATE_DOCUMENTUpload a document for an existing candidate on a specified Breezy HR position. Use this to attach additional files, such as a cover letter, portfolio, or certification, to the candidate’s application.

Input Parameters

object
required
The document file to upload. The file name should match the intended candidate document filename (for example, ‘resume.pdf’, ‘cover_letter.docx’, or ‘certificate.png’). This will be sent as multipart form field named ‘data’.
string
required
The unique identifier of the company in Breezy HR.
string
required
The unique identifier of the position (job posting).
string
required
The unique identifier of the 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: BREEZY_HR_ADD_CANDIDATE_EDUCATIONAdd an education entry to an existing candidate on a position in Breezy HR. The entry is appended to the candidate’s education history.

Input Parameters

integer
The year the education ended (or expected end year if still studying).
string
required
The unique identifier of the company in Breezy HR.
integer
The year the education started.
string
required
The unique identifier of the position (job posting).
string
required
The name of the educational institution.
string
required
The unique identifier of the candidate.
string
The field of study or major.

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: BREEZY_HR_ADD_CANDIDATE_NOTEAdds a note to a candidate’s discussion stream in Breezy HR. Use this action when you need to record observations, interview feedback, or any communication about a candidate directly in their profile. The note becomes part of the candidate’s activity history and is visible to all users with access to the candidate.

Input Parameters

string
required
The content of the note to add to the candidate’s discussion stream. This will appear in the candidate’s activity feed.
string
required
The unique identifier for the company. Found in the Breezy HR dashboard URL or company settings.
string
required
The unique identifier for the job position. Found in the position URL or position details page.
string
required
The unique identifier for the candidate. Found in the candidate profile URL or candidate 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: BREEZY_HR_ADD_CANDIDATE_RESUMEUpload a resume for an existing candidate on a specified Breezy HR position. Use this to add a resume or replace the candidate’s current resume.

Input Parameters

object
required
The resume file to upload. The file name should match the candidate’s resume filename (for example, ‘resume.pdf’ or ‘john_doe_cv.pdf’).
string
required
The unique identifier of the company. This can be found in the company details or URL.
string
required
The unique identifier of the position. This can be found in the position details or URL.
string
required
The unique identifier of the candidate. This can be found in the candidate details or URL.

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: BREEZY_HR_ADD_CANDIDATE_WORK_HISTORYAdd a work history entry to an existing candidate for a position in Breezy HR, recording employment details such as company, title, dates, and responsibilities. The entry is appended rather than updating an existing entry for the same company.

Input Parameters

string
The job title or role at the company.
string
A description of the work performed or accomplishments.
integer
The year when the work ended. Set to the current year if still employed.
integer
The month when the work ended (1-12). Set to the current month if still employed.
string
required
The unique identifier of the company in Breezy HR.
integer
The year when the work started.
string
required
The unique identifier of the position (job posting).
integer
The month when the work started (1-12).
string
required
The unique identifier of the candidate.
string
required
The name of the company where the candidate worked.

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: BREEZY_HR_CREATE_CANDIDATEAdd a new candidate to a position in Breezy HR. Use when you need to create or add a candidate to a specific job position. This action allows you to programmatically add candidates to positions with various details including contact information, education, work history, social profiles, and custom attributes. The candidate can be marked as ‘sourced’ (direct hire) or ‘applied’ (applicant tracking). Note: If origin is ‘applied’, email_address is required. For ‘sourced’ candidates, email is optional but recommended.

Input Parameters

string
required
Full name of the candidate
array
Tags/labels to associate with the candidate
string ("sourced" | "applied")
Origin type for the candidate.
string
Custom source to attribute to the incoming candidate
string
Physical address of the candidate
string
Professional summary or bio
array
Educational background of the candidate
string
required
Unique identifier for the company. Found in Breezy HR settings or URL.
string
required
Unique identifier for the position/job. Found in Breezy HR or URL.
string
Cover letter or personal statement
string
Phone number of the candidate
array
Work history of the candidate
string
Email address of the candidate. Required when origin is ‘applied’.
object
Social media profiles for the candidate.
array
Custom key-value attributes for the candidate. The secure flag determines if values are encrypted at rest.

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: BREEZY_HR_CREATE_CANDIDATE_FROM_RESUMEUpload and parse a resume file to create a new candidate in Breezy HR. Use this action when you need to add a new job candidate by uploading their resume. The resume is parsed and candidate information is automatically extracted and associated with the specified position. The candidate will be placed in the default ‘applied’ stage unless a different stage_id is specified.

Input Parameters

object
required
Resume file to upload. The file name should match the candidate’s resume filename (for example, ‘resume.pdf’ or ‘john_doe_resume.docx’). The file content will be parsed to extract candidate information.
string
ID of the pipeline stage to place the new candidate in. Defaults to ‘applied’ if not specified.
string
required
The unique identifier of the company in Breezy HR.
string
required
The unique identifier of the position to attach the candidate to.
boolean
Whether to execute stage actions configured for the stage where the candidate is being created. Defaults to false.

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: BREEZY_HR_CREATE_POSITIONCreate a new Breezy HR position for a company with details such as title, description, location, and employment type.

Input Parameters

string
required
The name/title of the position.
array
Tags to associate with the position for organization and filtering.
string ("fullTime" | "partTime" | "contract" | "temporary" | "other")
required
The type of employment for this position.
string ("software" | "design" | "product" | "sysadmin" | "devops" | "finance" | "custserv" | "sales" | "marketing" | "pr" | "design-not-interactive" | "hr" | "management" | "operations" | "other")
Category classification for the position.
object
required
The location details for the position. Must include at least country.
string ("unspecified" | "high-school" | "certification" | "vocational" | "associate-degree" | "bachelor-degree" | "masters-degree" | "doctorate" | "professional" | "some-college" | "vocational-diploma" | "vocational-degree" | "some-high-school")
Education level required for the position.
string
required
The unique identifier of the company in Breezy HR.
string
The department this position belongs to.
string ("na" | "internship" | "entry-level" | "associate" | "mid-level" | "senior-level" | "executive")
Experience level required for the position.
string
required
The detailed description of the position including responsibilities and requirements.
string
The ID of the pipeline to use for this position. Defaults to ‘default’.
string
The ID of a scorecard template to use for candidate evaluation.
string
An internal requisition reference ID.
object
Configuration for application form field visibility.
string
The ID of a questionnaire to attach to the position.
array
Custom attributes to attach to the position. Secure attributes are encrypted at rest.

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: BREEZY_HR_CREATE_WEBHOOK_ENDPOINTCreate a new webhook endpoint to receive event notifications from Breezy HR. Use this action when you need to set up real-time notifications for events such as candidates being added, deleted, or having their status updated. The response includes a secret key that should be stored securely to verify incoming webhook signatures. This action is idempotent based on the endpoint URL and subscribed events.

Input Parameters

string
required
The URL that will receive webhook notifications when subscribed events occur.
array
required
List of event types to subscribe to. The endpoint will receive notifications for these events.
string
required
The unique identifier of the company in Breezy HR.
string
An optional description to help identify the webhook endpoint.

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: BREEZY_HR_DELETE_WEBHOOK_ENDPOINTDelete an existing webhook endpoint from Breezy HR. Use this action when you need to remove a webhook endpoint that is no longer needed for receiving real-time notifications about Breezy HR events such as candidate additions, deletions, or status updates. This action is irreversible — the webhook endpoint cannot be recovered once deleted.

Input Parameters

string
required
The unique identifier of the company in Breezy HR.
string
required
The unique identifier of the webhook endpoint to delete.

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: BREEZY_HR_GET_CANDIDATERetrieve candidate details by ID for a given position in Breezy HR. Use this action when you need to fetch the full profile and details of a specific candidate applying to a specific job position. This includes contact information, social accounts, recruitment stage, rating, source, and other candidate metadata. This is a read-only operation that does not modify any candidate data.

Input Parameters

string
required
The unique identifier of the company.
string
required
The unique identifier of the position/job posting.
string
required
The unique identifier of the 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: BREEZY_HR_GET_CANDIDATE_CONVERSATIONRetrieve the conversation stream for a specific candidate applying to a position. Use when you need to view all messages exchanged with a candidate, including messages sent by the hiring team and responses from the candidate. The conversation includes timestamps, message content, attachments, and sender information.

Input Parameters

integer
Number of records to skip for paging
string
required
Unique identifier of the company
string
required
Unique identifier of the position
string
required
Unique identifier of the candidate
integer
Set to 1 to include any messages that are currently queued for delayed delivery

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: BREEZY_HR_GET_CANDIDATE_METARetrieves candidate meta data by ID for a given position. Use this action when you need to fetch all metadata information (assessments, documents, scorecards, etc.) associated with a specific candidate for a specific job position. The metadata includes various aspects of the candidate’s interaction and evaluation such as assessments, background checks, conversation history, documents, questionnaires, references, schedule, scorecards, stream activity, tasks, and team notes.

Input Parameters

string
required
The unique identifier of the company.
string
required
The unique identifier of the position/job posting.
string
required
The unique identifier of the 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: BREEZY_HR_GET_CANDIDATE_RESUMERetrieve a candidate’s resume file from a specific job position in Breezy HR. Use this action when you need to download and review a candidate’s resume/CV for a specific job application. The resume is typically returned as a PDF or Word document. This action streams the resume file directly from Breezy HR’s servers.

Input Parameters

string
required
The unique identifier of the company in Breezy HR.
string
required
The unique identifier of the position (job posting).
string
required
The unique identifier of the 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: BREEZY_HR_GET_CANDIDATE_STREAMRetrieves the last 50 candidate discussion stream events by candidate ID for a given position. Use this action when you need to view the conversation history, activity timeline, status changes, or all interactions related to a specific candidate within a job position. This is useful for tracking candidate engagement, reviewing hiring team notes, or monitoring the progression through the pipeline.

Input Parameters

string
required
The unique identifier for the company. Found in Breezy HR dashboard URL or company settings.
string
required
The unique identifier for the job position. Found in the position URL in Breezy HR.
string
required
The unique identifier for the candidate. Found in the candidate profile URL.

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: BREEZY_HR_GET_COMPANYRetrieve a company’s public profile in Breezy HR by company ID. The returned fields are limited by the action’s response model.

Input Parameters

string
required
The unique identifier of the company. Found in your Breezy HR dashboard URL.

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: BREEZY_HR_GET_PIPELINERetrieves pipeline stages by pipeline ID for a specified company. Use when you need to fetch the hiring workflow stages associated with a particular pipeline, including stage names, icons, action counts, and associated actions.

Input Parameters

string
required
The unique identifier of the company. Found in your Breezy HR dashboard URL.
string
required
The unique identifier of the pipeline to retrieve.

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: BREEZY_HR_GET_POSITIONRetrieve details of a specific Breezy HR position by company and position ID. The action returns selected position fields rather than the complete position record.

Input Parameters

string
required
The unique identifier of the company. This is the company ID from Breezy HR.
string
required
The unique identifier of the position to retrieve.

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: BREEZY_HR_GET_POSITION_TEAMRetrieves user objects of all team members assigned to a specific job position. Use this action when you need to view the hiring team members associated with a particular position, including their names, email addresses, usernames, roles (Hiring Team Member or Hiring Manager), and account details. This is useful for understanding who has access to and responsibility for a specific job posting in your Breezy HR account.

Input Parameters

string
required
The unique identifier for the company. Found in your Breezy HR dashboard URL.
string
required
The unique identifier for the job position. Found in the position URL in Breezy HR.

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: BREEZY_HR_GET_QUESTIONNAIRERetrieves a questionnaire by its ID for a specific company. Use this action when you need to fetch the details, questions, and settings of an existing questionnaire in Breezy HR.

Input Parameters

string
required
The unique identifier of the company. Found in your Breezy HR dashboard URL or company settings.
string
required
The unique identifier of the questionnaire to retrieve.

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: BREEZY_HR_GET_TEMPLATERetrieves an email template by its ID for a specific company. Use this action when you need to fetch the details, subject line, body content, and settings of an existing email template in Breezy HR.

Input Parameters

string
required
The unique identifier of the company. Found in your Breezy HR dashboard URL or company settings.
string
required
The unique identifier of the template to retrieve.

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: BREEZY_HR_GET_USERRetrieve the authenticated user’s profile from Breezy HR. The action accepts an optional user ID as a query parameter, but the endpoint returns the authenticated user’s profile.

Input Parameters

string
The unique identifier of the user to retrieve. If not provided, returns the authenticated user.

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: BREEZY_HR_GET_USER_DETAILSRetrieves the details for the configurations of each company the authenticated user belongs to. This includes company information, hiring pipelines, questionnaires, templates, tasks, scorecards, and team member data. Use this action when you need to fetch comprehensive user and company configuration data for the authenticated user across all accessible companies.

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: BREEZY_HR_GET_WEBHOOK_ENDPOINTRetrieves detailed information about a specific webhook endpoint by its ID. Use this action when you need to fetch details about an existing webhook endpoint, including its configuration, subscribed events, status, and delivery statistics. This is a read-only operation that does not modify any data.

Input Parameters

string
required
The unique identifier of the company in Breezy HR.
string
required
The unique identifier of the webhook endpoint to retrieve.

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: BREEZY_HR_LIST_CANDIDATE_ASSESSMENTSRetrieves all 3rd party assessments a candidate has taken for a specific position. Use this action when you need to: - View the assessment history for a specific candidate - Check the status of ongoing or pending assessments - Retrieve assessment results and reports - Verify candidate has completed required pre-employment assessments This action queries the Breezy HR API to get all assessments associated with a candidate within a specific position and company context.

Input Parameters

string
required
The unique identifier of the company.
string
required
The unique identifier of the position.
string
required
The unique identifier of the 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: BREEZY_HR_LIST_CANDIDATE_BACKGROUND_CHECKSRetrieves all 3rd party background checks for a candidate. Use this action when you need to: - View the background check history for a specific candidate - Check the status of ongoing background checks - Retrieve background check results and reports This action queries the Breezy HR API to get all background checks associated with a candidate within a specific position and company context.

Input Parameters

string
required
The unique identifier of the company.
string
required
The unique identifier of the position.
string
required
The unique identifier of the 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: BREEZY_HR_LIST_CANDIDATE_CUSTOM_ATTRIBUTESRetrieves all candidate-specific custom attributes configured for a company. Use this action when you need to list all available custom fields that can be used to store additional candidate information beyond the standard Breezy HR candidate fields. These custom attributes can include things like desired salary, source of application, department preferences, or any other company-specific data points. This is a read-only operation that does not modify any data.

Input Parameters

string
required
The unique identifier of the company. This is a required path parameter.

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: BREEZY_HR_LIST_CANDIDATE_CUSTOM_FIELDSRetrieves all custom field values for a specific candidate in the context of a job position. Use when you need to get the values of custom fields that have been filled out for a candidate in a specific job application, such as source of application, desired salary, department preference, or any other company-defined custom data points. This is a read-only operation that does not modify any data.

Input Parameters

string
required
The unique identifier of the company.
string
required
The unique identifier of the position/job posting.
string
required
The unique identifier of the 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: BREEZY_HR_LIST_CANDIDATE_DOCUMENTSRetrieve candidate documents by candidate ID for a given position. Use when you need to list all documents associated with a specific candidate for a specific job position. The documents may include resumes, cover letters, portfolios, or other relevant files.

Input Parameters

string
required
The unique identifier for the company.
string
required
The unique identifier for the position.
string
required
The unique identifier for the 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: BREEZY_HR_LIST_CANDIDATE_QUESTIONNAIRESRetrieves all questionnaires for a specific candidate. Use this action when you need to: - View all questionnaires associated with a candidate - Check the status of questionnaire submissions - Retrieve questionnaire completion dates and scores - Track pending or overdue questionnaires This action queries the Breezy HR API to get all questionnaires associated with a candidate within a specific position and company context.

Input Parameters

string
required
The unique identifier of the company.
string
required
The unique identifier of the position.
string
required
The unique identifier of the 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: BREEZY_HR_LIST_COMPANIESRetrieve the companies associated with the authenticated user. Use this action when you need to discover what companies are accessible to the authenticated user, such as for listing available workspaces or checking company details.

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: BREEZY_HR_LIST_PIPELINESRetrieve the hiring pipelines configured for a Breezy HR company. The result is keyed by pipeline name and includes each pipeline’s ordered stages.

Input Parameters

string
required
The unique identifier of the company

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: BREEZY_HR_LIST_POSITION_CUSTOM_ATTRIBUTESRetrieve all position-specific custom attributes defined for a company in Breezy HR. Use this action when you need to discover what custom fields are available for job positions, such as for building forms, validating attribute values, or understanding position data structure.

Input Parameters

string
required
The unique identifier of the company. This is the company ID from Breezy HR.

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: BREEZY_HR_LIST_POSITION_CUSTOM_FIELDSRetrieve all custom fields for a specific position in Breezy HR. Use this action when you need to fetch the custom field values assigned to a particular job position, such as when reviewing candidate applications or updating position details. This action retrieves the custom field values (name, value, and security flag) that are associated with the specified position.

Input Parameters

string
required
The unique identifier of the company in Breezy HR.
string
required
The unique identifier of the position/job posting.

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: BREEZY_HR_LIST_POSITIONSRetrieves all job positions for a specified company, optionally filtered by state. Use when you need to find available job openings, list company positions, or get position details for a Breezy HR company account. The state filter defaults to ‘published’ to return only active job listings.

Input Parameters

string ("draft" | "archived" | "published" | "closed" | "pending")
Valid values for position state filter.
string
required
The unique identifier of the company. Found in your Breezy HR dashboard URL.

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: BREEZY_HR_LIST_QUESTIONNAIRESRetrieves all company questionnaires from Breezy HR. Use this action when you need to fetch all available questionnaires associated with a specific company in the Breezy HR system.

Input Parameters

string
required
The unique identifier of the company

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: BREEZY_HR_LIST_TEMPLATESRetrieves all company email templates from Breezy HR. Use this action when you need to fetch all available email templates associated with a specific company in the Breezy HR system. This is useful for finding templates to use in candidate communications, customizing email workflows, or managing company communication templates.

Input Parameters

string
required
The unique identifier of the company. Found in your Breezy HR dashboard URL.

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: BREEZY_HR_LIST_WEBHOOK_ENDPOINTSList webhook endpoints configured for a specified Breezy HR company to review their event subscriptions and configuration. This is a read-only operation.

Input Parameters

string
required
The unique identifier of the company in Breezy HR.

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: BREEZY_HR_PAUSE_WEBHOOK_ENDPOINTPause webhook delivery to a Breezy HR endpoint without deleting its configuration. The endpoint can be resumed later; pausing sets its status to paused and enabled to false.

Input Parameters

string
required
The unique identifier of the company in Breezy HR.
string
required
The unique identifier of the webhook endpoint to pause.

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: BREEZY_HR_RESUME_WEBHOOK_ENDPOINTResume webhook delivery to a paused endpoint in Breezy HR. Use when you need to resume webhook delivery to an endpoint that was previously paused. Once resumed, the endpoint will start receiving webhook notifications for subscribed events again.

Input Parameters

string
required
The unique identifier of the company in Breezy HR.
string
required
The unique identifier of the webhook endpoint to resume.

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: BREEZY_HR_SEARCH_CANDIDATESSearch for candidates by their email address across all positions in a company. Use when you need to find candidates with a specific email address, verify if a candidate exists in the system, or retrieve candidate information based on email. This is a read-only operation that searches across all positions and pipelines.

Input Parameters

string
required
The unique identifier of the company. Found in your Breezy HR dashboard URL.
string
required
The email address to search for candidates. Must be a valid email format.

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: BREEZY_HR_UPDATE_CANDIDATETool to update a candidate on a specific position in Breezy HR. Use when you need to modify candidate information such as their headline, contact details, social profiles, tags, or other details on an existing candidate application. The candidate must already exist for the specified position. This action makes a PUT request to update the candidate’s information.

Input Parameters

string
Full name of the candidate
array
Array of tags to organize or categorize the candidate
string
Custom source to attribute to the incoming candidate
string
Physical address of the candidate
string
Summary or biography of the candidate
string
Professional headline or title for the candidate
string
required
Unique identifier for the company
string
required
Unique identifier for the position
string
required
Unique identifier for the candidate
string
Cover letter or introduction text
string
Phone number of the candidate
string
Email address of the candidate
object
Social media profile URLs for the 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: BREEZY_HR_UPDATE_CANDIDATE_SCORECARDUpdate a candidate’s scorecard for a specific position in a company. Use this action when you need to record a candidate’s evaluation score and optional notes during the hiring process. This action is idempotent — calling it multiple times with the same parameters will update (not duplicate) the scorecard.

Input Parameters

string
An optional note to add with the score.
string ("very_poor" | "poor" | "neutral" | "good" | "very_good")
required
The score code for the candidate scorecard. One of: very_poor, poor, neutral, good, very_good.
string
required
The unique identifier of the company.
string
required
The unique identifier of the position (job).
string
required
The unique identifier of the 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: BREEZY_HR_UPDATE_CANDIDATE_STAGEMove a candidate to a specified stage in the hiring pipeline. Use when you need to advance, move, or reassign a candidate to a different stage in the recruitment process (e.g., from ‘applied’ to ‘interviewing’, or ‘interviewing’ to ‘offer’). The action requires the company ID, position ID, candidate ID, and the target stage ID.

Input Parameters

string
required
The ID of the Pipeline stage to put the candidate in. Common stage values include: hired, disqualified, offer, feedback, interviewing, applied.
string
required
The unique identifier for the company.
string
required
The unique identifier for the position (job opening).
string
required
The unique identifier for the 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: BREEZY_HR_UPDATE_POSITIONUpdate supported details of an existing Breezy HR position, such as its name, description, department, employment type, category, requirements, location, and tags.

Input Parameters

string
The name or title of the position
array
Array of tags to organize or categorize the position
string ("fullTime" | "partTime" | "contract" | "temporary" | "other")
Enumeration of position types.
string ("software" | "design" | "product" | "sysadmin" | "devops" | "finance" | "custserv" | "sales" | "marketing" | "pr" | "design-not-interactive" | "hr" | "management" | "operations" | "other")
Enumeration of position categories.
object
Location object for a position.
string ("unspecified" | "high-school" | "certification" | "vocational" | "associate-degree" | "bachelors-degree" | "masters-degree" | "doctorate" | "professional" | "some-college" | "vocational-diploma" | "vocational-degree" | "some-high-school")
Enumeration of education levels for positions.
string
required
The unique identifier of the company. This can be found in the company details or URL.
string
The department this position belongs to
string ("na" | "internship" | "entry-level" | "associate" | "mid-level" | "senior-level" | "executive")
Enumeration of experience levels for positions.
string
Detailed description of the position and responsibilities
string
ID of the hiring pipeline to use for this position
string
required
The unique identifier of the position to update. This can be found in the position details or URL.
string
ID of the scorecard template to use for evaluating candidates
string
External requisition tracking ID
object
Application form field settings.
string
ID of the screening questionnaire to attach to this position
array
Custom attributes for the position. Secure attributes are encrypted at rest.

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: BREEZY_HR_UPDATE_POSITION_STATEUpdate the state of an existing position in Breezy HR. Use when you need to change a position’s workflow state (e.g., from draft to published, or closing a position after hiring is complete). This action is commonly used during recruitment workflow management.

Input Parameters

string ("draft" | "published" | "closed" | "archived")
required
The new state for the position. Valid values are: draft, published, closed, archived.
string
required
The unique identifier of the company. This can be found in the company details or URL.
string
required
The unique identifier of the position to update. This can be found in the position details or URL.

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: BREEZY_HR_UPDATE_WEBHOOK_ENDPOINTUpdate an existing webhook endpoint to receive event notifications from Breezy HR. Use when you need to modify the configuration of an existing webhook endpoint, such as changing the target URL, updating the description, modifying subscribed events, or enabling/disabling the endpoint. The endpoint must already exist for the specified company. This action makes a PUT request to update the webhook endpoint’s configuration.

Input Parameters

string
The HTTPS URL that will receive webhook notifications when subscribed events occur.
array
List of event types to subscribe to. The endpoint will receive notifications for these events.
boolean
Whether the webhook endpoint is enabled. Set to false to temporarily disable webhook deliveries.
string
required
The unique identifier of the company in Breezy HR.
string
An optional description to help identify the webhook endpoint.
string
required
The unique identifier of the webhook endpoint to update.

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