Description

n8n-nodes-awork

This n8n community package provides nodes for awork and awork AI. Use awork for project management workflows, or awork AI for agents, threads, schedules, and shared workspace resources.

awork AI

Install the same n8n-nodes-awork package, then select awork AI on your canvas. Create awork AI API credentials with an API key from your awork AI workspace. This node sends requests and tests credentials against https://api.awork-ai.com.

| Resource | Operations |
| — | — |
| Agents | Create, get, list visible agents |
| Threads | Create with a first message, get, send a message, get messages, get message status, cancel the active run |
| Schedules | Create, list by agent, list owned schedules, update, delete, run, enable/disable |
| Projects | Create, get, list, update, delete; change status; list/create project statuses |
| Documents | Create, get, list, update metadata/content, delete; list by project or document space |
| Document spaces | Create, get, list, update, delete |
| Files | Upload binary data or a public URL, get, list, update metadata, delete, download for projects, documents, and users |
| Users | Get, list |

The awork AI node reuses shared awork operations and pagination. Its controls exclude tasks, task lists, task statuses, time entries, and project billing fields. Use an existing agent ID to start a custom-agent thread or manage its schedules. API permissions, workspace AI availability, and usage limits still apply.

AI replies are asynchronous. Create Thread and Send Message return acceptance receipts. Keep the thread ID and accepted message ID, add an n8n Wait step, and use Get Message Status to check progress. Use Get Messages to read the reply. Retrying a submission can create another thread or message. See the thread API.

Schedules use a cron rule and an optional IANA timezone. Update Schedule replaces its settings: supply the current optional values to retain them. Use Set Enabled to pause or resume without replacing other settings.

awork AI Trigger

Select awork AI Trigger to start a workflow from awork AI webhook events. It uses awork AI API credentials with admin access and a public n8n webhook URL. Select one or more events, then activate the workflow. The trigger registers the webhook on activation and removes it on deactivation. Its output contains body, headers, and query, matching the existing awork trigger.

The event selector loads available event types from the API. It includes supported project and user events and excludes task, company, time-tracking, and absence events. Agent events will appear in the selector when the API returns them; refresh the event list to see new types. They must be selected before they can start the workflow. The trigger does not poll for AI replies.

The existing awork and awork Trigger nodes retain their operations and credentials.

Installation

n8n Cloud

1. Select + on your canvas and type awork
2. Find awork in the More from the community section
3. Select install

Follow the official installation guide for n8n community nodes.

Self-Hosted Instance

1. Navigate to Settings > Community Nodes
2. Select Install
3. Enter n8n-nodes-awork in Enter npm package name
4. Select Install
5. Restart your n8n instance after installation

Authentication

To use the awork node, you’ll need API credentials from awork:

1. Create an awork account at awork.com if you don’t have one
2. Generate an API key by following the instructions in the awork API Authentication documentation
3. In n8n, add new credentials:
– Select “awork API” from the credentials list
– Enter your API key
– Test the connection to ensure it’s working

Available Operations

The node supports the following operations:

| Resource | Operations |
| — | — |
| Projects | Create, get, list, update, delete; change status; list/create project and task statuses |
| Project tasks | Create, get, list by project, update, delete; change status; set assignees and custom fields; add tags and comments; list comments |
| Companies | Create, get, list, update, delete |
| Time entries | Create, get, list, update, delete; list by project or task |
| Documents | Create, get, list, update metadata, get/update content, delete; list by project or document space |
| Document spaces | Create, get, list, update, delete |
| Task lists (under Project) | Create, get, list, update, delete; add tasks via Project Task |
| Users | Get, list |
| Custom fields | Read workspace/project definitions and project/task values; set or clear typed values |
| Comments | Create, get, list, update, delete on projects, tasks, and documents; resolve document comments |
| Project members | List, add, update, remove; list project roles |
| Company contacts | Create, get, list, update, delete email, phone, address, URL, and custom contact information |
| Checklist items | Create, get, list, update, delete under a task |
| Absences | Create, get, list, update, delete; full-day and half-day options |
| Tags | List used/entity tags, add/remove entity tags, update/delete tags globally for companies/projects/tasks/users |
| Files | Upload binary data or a public URL, get, update metadata, delete, download; list where supported |
| Types of work | Create, get, list, update, delete with optional replacement, archive/unarchive, list icons; existing Project Task operations retained |

Paginated list operations support Return All, Filter By, and Order By. With Return All disabled, the node retrieves the first API page; enable it to retrieve all pages. Custom-field definitions, project members, checklist items, tags, and type-of-work icons return complete unpaginated lists.

Updates expose only the selected Update Fields in the request, including explicit false, 0, or empty text values. Company, project, and task updates require the name; time-entry updates require the type of work ID and IANA timezone, as specified by the API. Supply the current values when changing other fields.

Time-entry creation uses separate UTC date and time fields (time format HH:mm:ss), a user ID, a type of work ID, and the entry’s original IANA timezone. For a completed entry, add Duration (Seconds) or an end date/time under Additional Fields. The node sends UTC fields only, so it does not mix the API’s UTC and local date/time groups.

Documents accept HTML or Markdown text. The node uploads content as a UTF-8 file using the API’s required multipart format. Use Update Document for metadata and Update Document Content for the text. Creating a document supports a project, document space, task, or private document.

Project and task deletion preserve time entries by default. Company deletion defaults to deleting only the company. Task-list deletion preserves tasks and times by default. Document deletion exposes Also Delete Children; document-space deletion removes its documents according to the API.

Custom Field reads definitions and values for existing fields. Choose Project or Task, a field definition ID, and a value type (text/link, number, boolean, date/time, user, client, or selection option). Clear Value sends an explicit null. Creating, editing, deleting, or linking field definitions is not exposed.

Comment, Tag, and File use a Parent Resource selector and Parent ID. Comments support projects, tasks, and documents; resolving a comment applies only to documents. Project-member changes require a user ID and project role ID; use Get Project Roles to find the role.

Company contacts require a type and subtype, except custom contacts, which require a label. Use address fields for postal addresses. Absence create/update requires a user and start/end dates; add the provider and half-day flags as needed. An external provider makes the absence managed by that provider and read-only in the awork UI.

Files support projects, tasks, documents, companies, and users. Upload File reads the specified incoming n8n binary field (default data); Download File writes the chosen output binary field, retaining the API filename and MIME type. Upload File From URL lets awork fetch a public URL. File listing is available for projects, tasks, documents, and users; the API has no company file-list endpoint.

Existing operation values are preserved so saved workflows continue to work. For endpoints not exposed here, use n8n’s HTTP Request node with awork API credentials. See the awork OpenAPI specification for the request schemas and awork Developer Documentation for API usage.

Example Workflows

Here are some common use cases for the awork nodes:

1. Automated Project Creation: Create projects in awork when new deals are won in your CRM
2. Task Synchronization: Sync tasks between awork and other project management tools
3. Company Management: Automatically create companies in awork from form submissions
4. Status Updates: Update task statuses based on external triggers
5. Time Tracking: Create and synchronize time entries from calendars or external time trackers
6. Document Automation: Create and update project documents from workflow results
7. Reporting: Extract project and task data for custom reporting dashboards

Resources

• awork Developer Documentation: developers.awork.com
• awork Developer Forum: community.awork.com/c/developer-forum/17
• n8n Documentation: docs.n8n.io
• n8n Community: community.n8n.io

Support

If you encounter any issues or have questions:

• Check the awork Developer Forum for API-related questions
• Visit the n8n Community Forum for n8n-specific issues

Local Development

For contributors and developers who want to test changes locally:

1. Clone the repository:

   git clone https://github.com/awork-io/n8n-nodes-awork
   cd n8n-nodes-awork
   

2. Install dependencies and build:

   npm install
   npm run build
   

3. Link to your local n8n installation:

   npm link
   cd ~/.n8n/custom
   npm link n8n-nodes-awork
   

4. Start n8n:

   n8n start
   

License

This project is licensed under the MIT License – see the LICENSE file for details.