# Breezy Hr

Integrate Breezy HR to streamline your recruiting and applicant tracking processes.

- **Category:** hr talent & recruitment
- **Auth:** None
- **Composio Managed App Available?** N/A
- **Tools:** 48
- **Triggers:** 0
- **Slug:** `BREEZY_HR`
- **Version:** 20260417_00

## Tools

### Add Candidate Custom Attribute

**Slug:** `BREEZY_HR_ADD_CANDIDATE_CUSTOM_ATTRIBUTE`

Add or update a custom attribute for a candidate in Breezy HR. Use when you need to store custom metadata, internal notes, evaluation scores, or any other custom data for a candidate application. If the attribute name already exists for this candidate, its value will be updated with the new value.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name/key of the custom attribute. |
| `value` | string | Yes | The value to assign to the custom attribute. |
| `secure` | boolean | No | Whether this value needs to be encrypted at rest. Defaults to false. |
| `company_id` | string | Yes | The unique identifier of the company in Breezy HR. |
| `position_id` | string | Yes | The unique identifier of the position (job posting). |
| `candidate_id` | string | Yes | The unique identifier of the 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 |

### Add Candidate Document

**Slug:** `BREEZY_HR_ADD_CANDIDATE_DOCUMENT`

Upload a document file for an existing candidate in Breezy HR. Use when you need to attach additional documents (cover letters, portfolios, certifications, or other files) to a candidate's application. The file is sent as multipart/form-data with the field name 'data'. This action is idempotent - uploading a document with the same name may create a duplicate or update the existing document depending on Breezy HR behavior.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | The document file to upload. FileUploadable object where 'name' should be the filename (e.g., 'resume.pdf', 'cover_letter.docx', 'certificate.png'). This will be sent as multipart form field named 'data'. |
| `file_path` | string | No | Optional local file path for testing. If provided, this will be used instead of the S3 file reference. Useful for testing or when the file is available locally. |
| `company_id` | string | Yes | The unique identifier of the company in Breezy HR. |
| `position_id` | string | Yes | The unique identifier of the position (job posting). |
| `candidate_id` | string | Yes | The unique identifier of the 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 |

### Add Candidate Education

**Slug:** `BREEZY_HR_ADD_CANDIDATE_EDUCATION`

Add an education entry to an existing candidate in Breezy HR. Use this action when you need to record a candidate's educational background, such as degrees, certifications, or school attendance. If an education entry already exists for the same school, it will be updated with the provided values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_year` | integer | No | The year the education ended (or expected end year if still studying). |
| `company_id` | string | Yes | The unique identifier of the company in Breezy HR. |
| `start_year` | integer | No | The year the education started. |
| `position_id` | string | Yes | The unique identifier of the position (job posting). |
| `school_name` | string | Yes | The name of the educational institution. |
| `candidate_id` | string | Yes | The unique identifier of the candidate. |
| `field_of_study` | string | No | The field of study or major. |

#### 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 |

### Add Candidate Note

**Slug:** `BREEZY_HR_ADD_CANDIDATE_NOTE`

Adds 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | The content of the note to add to the candidate's discussion stream. This will appear in the candidate's activity feed. |
| `company_id` | string | Yes | The unique identifier for the company. Found in the Breezy HR dashboard URL or company settings. |
| `position_id` | string | Yes | The unique identifier for the job position. Found in the position URL or position details page. |
| `candidate_id` | string | Yes | The unique identifier for the candidate. Found in the candidate profile URL or candidate 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 |

### Add candidate resume

**Slug:** `BREEZY_HR_ADD_CANDIDATE_RESUME`

Attach a resume file to an existing candidate in Breezy HR. Use when you need to add or update a candidate's resume document. The file is sent as multipart/form-data with the field name 'file'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | The resume file to upload. FileUploadable object where 'name' should be the filename (e.g., 'resume.pdf', 'john_doe_cv.pdf'). |
| `company_id` | string | Yes | The unique identifier of the company. This can be found in the company details or URL. |
| `position_id` | string | Yes | The unique identifier of the position. This can be found in the position details or URL. |
| `candidate_id` | string | Yes | The unique identifier of the candidate. This can be found in the candidate details or URL. |

#### 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 |

### Add Candidate Work History

**Slug:** `BREEZY_HR_ADD_CANDIDATE_WORK_HISTORY`

Add a work history entry to an existing candidate in Breezy HR. Use this action when you need to record a candidate's employment history, such as previous job positions, companies, and work responsibilities. If a work history entry already exists for the same company, it will be updated with the provided values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | The job title or role at the company. |
| `summary` | string | No | A description of the work performed or accomplishments. |
| `end_year` | integer | No | The year when the work ended. Set to the current year if still employed. |
| `end_month` | integer | No | The month when the work ended (1-12). Set to the current month if still employed. |
| `company_id` | string | Yes | The unique identifier of the company in Breezy HR. |
| `start_year` | integer | No | The year when the work started. |
| `position_id` | string | Yes | The unique identifier of the position (job posting). |
| `start_month` | integer | No | The month when the work started (1-12). |
| `candidate_id` | string | Yes | The unique identifier of the candidate. |
| `company_name` | string | Yes | The name of the company where the candidate worked. |

#### 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 |

### Add candidate to position

**Slug:** `BREEZY_HR_CREATE_CANDIDATE`

Add 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Full name of the candidate |
| `tags` | array | No | Tags/labels to associate with the candidate |
| `origin` | string ("sourced" | "applied") | No | Origin type for the candidate. |
| `source` | string | No | Custom source to attribute to the incoming candidate |
| `address` | string | No | Physical address of the candidate |
| `summary` | string | No | Professional summary or bio |
| `education` | array | No | Educational background of the candidate |
| `company_id` | string | Yes | Unique identifier for the company. Found in Breezy HR settings or URL. |
| `position_id` | string | Yes | Unique identifier for the position/job. Found in Breezy HR or URL. |
| `cover_letter` | string | No | Cover letter or personal statement |
| `phone_number` | string | No | Phone number of the candidate |
| `work_history` | array | No | Work history of the candidate |
| `email_address` | string | No | Email address of the candidate. Required when origin is 'applied'. |
| `social_profiles` | object | No | Social media profiles for the candidate. |
| `custom_attributes` | array | No | Custom key-value attributes for the candidate. The secure flag determines if values are encrypted at rest. |

#### 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 Candidate From Resume

**Slug:** `BREEZY_HR_CREATE_CANDIDATE_FROM_RESUME`

Upload 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | Resume file to upload. FileUploadable object where 'name' should be the filename (e.g., 'resume.pdf', 'john_doe_resume.docx'). The file content will be parsed to extract candidate information. |
| `stage_id` | string | No | ID of the pipeline stage to place the new candidate in. Defaults to 'applied' if not specified. |
| `file_path` | string | No | Optional local file path for testing. If provided, this will be used instead of the S3 file reference. Useful for testing or when the file is available locally. |
| `company_id` | string | Yes | The unique identifier of the company in Breezy HR. |
| `position_id` | string | Yes | The unique identifier of the position to attach the candidate to. |
| `stage_actions_enabled` | boolean | No | Whether to execute stage actions configured for the stage where the candidate is being created. Defaults to false. |

#### 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:** `BREEZY_HR_CREATE_POSITION`

Create a new position in Breezy HR. Use when you need to add a new job opening to your company's hiring pipeline with specific details like title, description, location, and employment type. This action creates a position that can then accept applications from candidates. The position will be created in draft state by default unless otherwise specified.

#### Input Parameters

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

#### 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 Webhook Endpoint

**Slug:** `BREEZY_HR_CREATE_WEBHOOK_ENDPOINT`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL that will receive webhook notifications when subscribed events occur. |
| `events` | array | Yes | List of event types to subscribe to. The endpoint will receive notifications for these events. |
| `company_id` | string | Yes | The unique identifier of the company in Breezy HR. |
| `description` | string | No | An optional description to help identify the webhook endpoint. |

#### 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 |

### Delete Webhook Endpoint

**Slug:** `BREEZY_HR_DELETE_WEBHOOK_ENDPOINT`

Delete 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company in Breezy HR. |
| `endpoint_id` | string | Yes | The unique identifier of the webhook endpoint to delete. |

#### 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 Candidate

**Slug:** `BREEZY_HR_GET_CANDIDATE`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company. |
| `position_id` | string | Yes | The unique identifier of the position/job posting. |
| `candidate_id` | string | Yes | The unique identifier of the 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 Candidate Conversation

**Slug:** `BREEZY_HR_GET_CANDIDATE_CONVERSATION`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of records to skip for paging |
| `company_id` | string | Yes | Unique identifier of the company |
| `position_id` | string | Yes | Unique identifier of the position |
| `candidate_id` | string | Yes | Unique identifier of the candidate |
| `include_delayed` | integer | No | Set to 1 to include any messages that are currently queued for delayed delivery |

#### 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 Candidate Meta

**Slug:** `BREEZY_HR_GET_CANDIDATE_META`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company. |
| `position_id` | string | Yes | The unique identifier of the position/job posting. |
| `candidate_id` | string | Yes | The unique identifier of the 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 Candidate Resume

**Slug:** `BREEZY_HR_GET_CANDIDATE_RESUME`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company in Breezy HR. |
| `position_id` | string | Yes | The unique identifier of the position (job posting). |
| `candidate_id` | string | Yes | The unique identifier of the 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 Candidate Stream

**Slug:** `BREEZY_HR_GET_CANDIDATE_STREAM`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier for the company. Found in Breezy HR dashboard URL or company settings. |
| `position_id` | string | Yes | The unique identifier for the job position. Found in the position URL in Breezy HR. |
| `candidate_id` | string | Yes | The unique identifier for the candidate. Found in the candidate profile URL. |

#### 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 Company Information

**Slug:** `BREEZY_HR_GET_COMPANY`

Retrieves complete information about a company in Breezy HR. Use when you need to fetch company details, settings, or profile information for a specific Breezy HR company account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company. Found in your Breezy HR dashboard URL. |

#### 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 Pipeline

**Slug:** `BREEZY_HR_GET_PIPELINE`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company. Found in your Breezy HR dashboard URL. |
| `pipeline_id` | string | Yes | The unique identifier of the pipeline to retrieve. |

#### 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:** `BREEZY_HR_GET_POSITION`

Retrieves detailed information about a specific job position by its ID. Use this action when you have a company ID and position ID and need to fetch the complete position details including description, location, requirements, and settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company. This is the company ID from Breezy HR. |
| `position_id` | string | Yes | The unique identifier of the position to retrieve. |

#### 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 Team

**Slug:** `BREEZY_HR_GET_POSITION_TEAM`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier for the company. Found in your Breezy HR dashboard URL. |
| `position_id` | string | Yes | The unique identifier for the job position. Found in the position URL in Breezy HR. |

#### 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 Questionnaire

**Slug:** `BREEZY_HR_GET_QUESTIONNAIRE`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company. Found in your Breezy HR dashboard URL or company settings. |
| `questionnaire_id` | string | Yes | The unique identifier of the questionnaire to retrieve. |

#### 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 Email Template

**Slug:** `BREEZY_HR_GET_TEMPLATE`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company. Found in your Breezy HR dashboard URL or company settings. |
| `template_id` | string | Yes | The unique identifier of the template to retrieve. |

#### 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 User

**Slug:** `BREEZY_HR_GET_USER`

Retrieves information about the authenticated user or a specific user by ID. Use this action when you need to fetch user profile details, including name, email, role, and other account information from Breezy HR. If user_id is not provided, the action returns the currently authenticated user's information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | The unique identifier of the user to retrieve. If not provided, returns the authenticated user. |

#### 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 User Details

**Slug:** `BREEZY_HR_GET_USER_DETAILS`

Retrieves 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

| 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 Webhook Endpoint

**Slug:** `BREEZY_HR_GET_WEBHOOK_ENDPOINT`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company in Breezy HR. |
| `endpoint_id` | string | Yes | The unique identifier of the webhook endpoint to retrieve. |

#### 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 Candidate Assessments

**Slug:** `BREEZY_HR_LIST_CANDIDATE_ASSESSMENTS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company. |
| `position_id` | string | Yes | The unique identifier of the position. |
| `candidate_id` | string | Yes | The unique identifier of the 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 |

### List Candidate Background Checks

**Slug:** `BREEZY_HR_LIST_CANDIDATE_BACKGROUND_CHECKS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company. |
| `position_id` | string | Yes | The unique identifier of the position. |
| `candidate_id` | string | Yes | The unique identifier of the 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 |

### List candidate custom attributes

**Slug:** `BREEZY_HR_LIST_CANDIDATE_CUSTOM_ATTRIBUTES`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company. This is a required path parameter. |

#### 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 Candidate Custom Fields

**Slug:** `BREEZY_HR_LIST_CANDIDATE_CUSTOM_FIELDS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company. |
| `position_id` | string | Yes | The unique identifier of the position/job posting. |
| `candidate_id` | string | Yes | The unique identifier of the 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 |

### List Candidate Documents

**Slug:** `BREEZY_HR_LIST_CANDIDATE_DOCUMENTS`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier for the company. |
| `position_id` | string | Yes | The unique identifier for the position. |
| `candidate_id` | string | Yes | The unique identifier for the 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 |

### List Candidate Questionnaires

**Slug:** `BREEZY_HR_LIST_CANDIDATE_QUESTIONNAIRES`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company. |
| `position_id` | string | Yes | The unique identifier of the position. |
| `candidate_id` | string | Yes | The unique identifier of the 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 |

### List Companies

**Slug:** `BREEZY_HR_LIST_COMPANIES`

Retrieve 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

| 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 Company Pipelines

**Slug:** `BREEZY_HR_LIST_PIPELINES`

Retrieve all pipelines for a company. Use this action when you need to list all hiring pipelines configured in a Breezy HR company account. This action is read-only and returns pipeline information including stages, positions, and settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company |

#### 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 Custom Attributes

**Slug:** `BREEZY_HR_LIST_POSITION_CUSTOM_ATTRIBUTES`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company. This is the company ID from Breezy HR. |

#### 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 Custom Fields

**Slug:** `BREEZY_HR_LIST_POSITION_CUSTOM_FIELDS`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company in Breezy HR. |
| `position_id` | string | Yes | The unique identifier of the position/job posting. |

#### 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 Breezy HR Positions

**Slug:** `BREEZY_HR_LIST_POSITIONS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `state` | string ("draft" | "archived" | "published" | "closed" | "pending") | No | Valid values for position state filter. |
| `company_id` | string | Yes | The unique identifier of the company. Found in your Breezy HR dashboard URL. |

#### 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 company questionnaires

**Slug:** `BREEZY_HR_LIST_QUESTIONNAIRES`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company |

#### 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 Company Templates

**Slug:** `BREEZY_HR_LIST_TEMPLATES`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company. Found in your Breezy HR dashboard URL. |

#### 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 Webhook Endpoints

**Slug:** `BREEZY_HR_LIST_WEBHOOK_ENDPOINTS`

Retrieves all webhook endpoints configured for a specified company in Breezy HR. Use when you need to list all registered webhook endpoints, audit which events are being monitored, or check the configuration of existing webhooks. This action is read-only and idempotent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company in Breezy HR. |

#### 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 |

### Pause Webhook Endpoint

**Slug:** `BREEZY_HR_PAUSE_WEBHOOK_ENDPOINT`

Pause webhook delivery to an endpoint in Breezy HR. Use when you need to temporarily stop receiving webhook notifications without deleting the endpoint configuration. The endpoint remains configured and can be resumed later. This action is useful during maintenance windows, debugging scenarios, or when you need to temporarily halt webhook processing while keeping the endpoint configuration intact. The endpoint status changes to 'paused' while the 'enabled' flag remains true, allowing for easy resumption.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company in Breezy HR. |
| `endpoint_id` | string | Yes | The unique identifier of the webhook endpoint to pause. |

#### 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 |

### Resume Webhook Endpoint

**Slug:** `BREEZY_HR_RESUME_WEBHOOK_ENDPOINT`

Resume 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company in Breezy HR. |
| `endpoint_id` | string | Yes | The unique identifier of the webhook endpoint to resume. |

#### 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 |

### Search Candidates by Email

**Slug:** `BREEZY_HR_SEARCH_CANDIDATES`

Search 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | string | Yes | The unique identifier of the company. Found in your Breezy HR dashboard URL. |
| `email_address` | string | Yes | The email address to search for candidates. Must be a valid email format. |

#### 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 Candidate

**Slug:** `BREEZY_HR_UPDATE_CANDIDATE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Full name of the candidate |
| `tags` | array | No | Array of tags to organize or categorize the candidate |
| `source` | string | No | Custom source to attribute to the incoming candidate |
| `address` | string | No | Physical address of the candidate |
| `summary` | string | No | Summary or biography of the candidate |
| `headline` | string | No | Professional headline or title for the candidate |
| `company_id` | string | Yes | Unique identifier for the company |
| `position_id` | string | Yes | Unique identifier for the position |
| `candidate_id` | string | Yes | Unique identifier for the candidate |
| `cover_letter` | string | No | Cover letter or introduction text |
| `phone_number` | string | No | Phone number of the candidate |
| `email_address` | string | No | Email address of the candidate |
| `social_profiles` | object | No | Social media profile URLs for the 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 |

### Update candidate scorecard

**Slug:** `BREEZY_HR_UPDATE_CANDIDATE_SCORECARD`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | No | An optional note to add with the score. |
| `score` | string ("very_poor" | "poor" | "neutral" | "good" | "very_good") | Yes | The score code for the candidate scorecard. One of: very_poor, poor, neutral, good, very_good. |
| `company_id` | string | Yes | The unique identifier of the company. |
| `position_id` | string | Yes | The unique identifier of the position (job). |
| `candidate_id` | string | Yes | The unique identifier of the 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 |

### Update Candidate Stage

**Slug:** `BREEZY_HR_UPDATE_CANDIDATE_STAGE`

Move 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stage_id` | string | Yes | The ID of the Pipeline stage to put the candidate in. Common stage values include: hired, disqualified, offer, feedback, interviewing, applied. |
| `company_id` | string | Yes | The unique identifier for the company. |
| `position_id` | string | Yes | The unique identifier for the position (job opening). |
| `candidate_id` | string | Yes | The unique identifier for the 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 |

### Update Position

**Slug:** `BREEZY_HR_UPDATE_POSITION`

Tool to update details of an existing position in Breezy HR. Use when you need to modify any attributes of an existing job position such as the name, description, department, employment type, category, education requirements, experience level, location, tags, or other position properties. The position must already exist for the specified company. This action makes a PUT request to update the position's information.

#### Input Parameters

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

#### 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 state

**Slug:** `BREEZY_HR_UPDATE_POSITION_STATE`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `state` | string ("draft" | "published" | "closed" | "archived") | Yes | The new state for the position. Valid values are: draft, published, closed, archived. |
| `company_id` | string | Yes | The unique identifier of the company. This can be found in the company details or URL. |
| `position_id` | string | Yes | The unique identifier of the position to update. This can be found in the position details or URL. |

#### 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 Webhook Endpoint

**Slug:** `BREEZY_HR_UPDATE_WEBHOOK_ENDPOINT`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | The HTTPS URL that will receive webhook notifications when subscribed events occur. |
| `events` | array | No | List of event types to subscribe to. The endpoint will receive notifications for these events. |
| `enabled` | boolean | No | Whether the webhook endpoint is enabled. Set to false to temporarily disable webhook deliveries. |
| `company_id` | string | Yes | The unique identifier of the company in Breezy HR. |
| `description` | string | No | An optional description to help identify the webhook endpoint. |
| `endpoint_id` | string | Yes | The unique identifier of the webhook endpoint to update. |

#### 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 |