n8n-nodes-base-wework

Tích hợp hoàn chỉnh Base WeWork API vào n8n - Quản lý projects, tasks, departments với action nodes và webhook triggers cho sự kiện real-time!

🚀 Quick Install

npm install n8n-nodes-base-wework

Sau đó restart n8n để load node.

✨ Features

Action Node (Base WeWork)

• 🎯 15+ Operations - Quản lý đầy đủ các hoạt động từ Base WeWork API v3
• 📦 3 Resources - Project, Task, Department
• 🔐 Secure Authentication - API key authentication với domain configuration
• ⚡ Production Ready - Error handling, type-safe, tested

Trigger Node (Base WeWork Trigger)

• ⚡ 6 Webhook Triggers - Nhận sự kiện real-time từ Base WeWork
• 🎪 Task Events - Task created, done, status updated
• 📋 Subtask Events - Subtask created, done, status updated
• 🔔 Real-time - Phản ứng ngay lập tức với các thay đổi

📚 Resources & Operations

Action Node Resources

Resource	Operations	Description
📁 Project	Create, Edit, Get Full, List	Quản lý dự án (tạo, sửa, xem chi tiết, danh sách)
✅ Task	Create, Create Subtask, Edit Basic Info, Edit Extra, Get, List by Project, Mark Done	Quản lý công việc và subtask
🏢 Department	Create, Edit, Get, List, Remove	Quản lý phòng ban

Trigger Node Events

Event	Description
🆕 On Task Created	Trigger khi task mới được tạo
✅ On Task Done	Trigger khi task được đánh dấu hoàn thành
🔄 On Task Status Updated	Trigger khi trạng thái task thay đổi
📋 On Subtask Created	Trigger khi subtask mới được tạo
✔️ On Subtask Done	Trigger khi subtask được đánh dấu hoàn thành
🔄 On Subtask Status Updated	Trigger khi trạng thái subtask thay đổi

🔧 Setup

1. Install node

npm install n8n-nodes-base-wework

2. Restart n8n

n8n start

3. Configure Credential

1. Mở n8n UI → Credentials → Add Credential
2. Chọn Base WeWork API
3. Nhập:
   • Domain: basevn.tech (hoặc domain Base WeWork của bạn)
   • Access Token: Token từ Base WeWork
4. Click Save

4. Use in Workflow

• Add node → Search "Base WeWork"
• Select credential
• Choose Resource and Operation
• Execute! ⚡

📖 Example Usage

Action Node Examples

Create Project

Node: Base WeWork
Resource: Project
Operation: Create
Username: @admin
Metatype: project
Name: My New Project
External: Inhouse (0)
Owners: @admin
Content: Project description

Create Task

Node: Base WeWork
Resource: Task
Operation: Create
Username: @admin
Project ID: 123
Tasklist ID: 456
Name: Important Task
Content: Task description
Assign: @user

List Projects

Node: Base WeWork
Resource: Project
Operation: List

Trigger Node Examples

Trigger on Task Created

Node: Base WeWork Trigger
Event: On Task Created
# Webhook URL sẽ được tạo tự động
# Cấu hình webhook này trong Base WeWork để nhận events

Trigger on Task Done

Node: Base WeWork Trigger
Event: On Task Done
# Tự động trigger workflow khi task được hoàn thành

🌐 API Documentation

Full API documentation: https://documenter.getpostman.com/view/1345096/SztA68Az?version=latest

🛠️ Development

# Clone repository
git clone https://github.com/basevn/n8n-nodes-base-wework.git
cd n8n-nodes-base-wework

# Install dependencies
npm install

# Build
npm run build

# Link for local development
npm link

📝 License

MIT © BaseVN

🆘 Support

• 📧 Email: support@basevn.tech
• 🌐 Website: https://basevn.tech
• 📖 Documentation: https://github.com/basevn/n8n-nodes-base-wework

🙏 Credits

Built with ❤️ for the n8n community

---

Keywords: n8n, base, wework, project management, task management, automation, workflow
npm run dev

This starts n8n with your nodes loaded and hot reload enabled.

## What's Included

This starter repository includes two example nodes to learn from:

- **[Example Node](nodes/Example/)** - A simple starter node that shows the basic structure with a custom `execute` method
- **[GitHub Issues Node](nodes/GithubIssues/)** - A complete, production-ready example built using the **declarative style**:
  - **Low-code approach** - Define operations declaratively without writing request logic
  - Multiple resources (Issues, Comments)
  - Multiple operations (Get, Get All, Create)
  - Two authentication methods (OAuth2 and Personal Access Token)
  - List search functionality for dynamic dropdowns
  - Proper error handling and typing
  - Ideal for HTTP API-based integrations

> [!TIP]
> The declarative/low-code style (used in GitHub Issues) is the recommended approach for building nodes that interact with HTTP APIs. It significantly reduces boilerplate code and handles requests automatically.

Browse these examples to understand both approaches, then modify them or create your own.

## Finding Inspiration

Looking for more examples? Check out these resources:

- **[npm Community Nodes](https://www.npmjs.com/search?q=keywords:n8n-community-node-package)** - Browse thousands of community-built nodes on npm using the `n8n-community-node-package` tag
- **[n8n Built-in Nodes](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/nodes)** - Study the source code of n8n's official nodes for production-ready patterns and best practices
- **[n8n Credentials](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/credentials)** - See how authentication is implemented for various services

These are excellent resources to understand how to structure your nodes, handle different API patterns, and implement advanced features.

## Prerequisites

Before you begin, install the following on your development machine:

### Required

- **[Node.js](https://nodejs.org/)** (v22 or higher) and npm
  - Linux/Mac/WSL: Install via [nvm](https://github.com/nvm-sh/nvm)
  - Windows: Follow [Microsoft's NodeJS guide](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows)
- **[git](https://git-scm.com/downloads)**

### Recommended

- Follow n8n's [development environment setup guide](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/)

> [!NOTE]
> The `@n8n/node-cli` is included as a dev dependency and will be installed automatically when you run `npm install`. The CLI includes n8n for local development, so you don't need to install n8n globally.

## Getting Started with this Starter

Follow these steps to create your own n8n community node package:

### 1. Create Your Repository

[Generate a new repository](https://github.com/n8n-io/n8n-nodes-starter/generate) from this template, then clone it:

```bash
git clone https://github.com/<your-organization>/<your-repo-name>.git
cd <your-repo-name>

2. Install Dependencies

npm install

This installs all required dependencies including the @n8n/node-cli.

3. Explore the Examples

Browse the example nodes in nodes/ and credentials/ to understand the structure:

• Start with nodes/Example/ for a basic node
• Study nodes/GithubIssues/ for a real-world implementation

4. Build Your Node

Edit the example nodes to fit your use case, or create new node files by copying the structure from nodes/Example/.

[!TIP]
If you want to scaffold a completely new node package, use npm create @n8n/node to start fresh with the CLI's interactive generator.

5. Configure Your Package

Update package.json with your details:

• name - Your package name (must start with n8n-nodes-)
• author - Your name and email
• repository - Your repository URL
• description - What your node does

Make sure your node is registered in the n8n.nodes array.

6. Develop and Test Locally

Start n8n with your node loaded:

npm run dev

This command runs n8n-node dev which:

• Builds your node with watch mode
• Starts n8n with your node available
• Automatically rebuilds when you make changes
• Opens n8n in your browser (usually http://localhost:5678)

You can now test your node in n8n workflows!

[!NOTE]
Learn more about CLI commands in the @n8n/node-cli documentation.

7. Lint Your Code

Check for errors:

npm run lint

Auto-fix issues when possible:

npm run lint:fix

8. Build for Production

When ready to publish:

npm run build

This compiles your TypeScript code to the dist/ folder.

9. Prepare for Publishing

Before publishing:

1. Update documentation: Replace this README with your node's documentation. Use README_TEMPLATE.md as a starting point.
2. Update the LICENSE: Add your details to the LICENSE file.
3. Test thoroughly: Ensure your node works in different scenarios.

10. Publish to npm

Publish your package to make it available to the n8n community:

npm publish

Learn more about publishing to npm.

11. Submit for Verification (Optional)

Get your node verified for n8n Cloud:

1. Ensure your node meets the requirements:

   • Uses MIT license ✅ (included in this starter)
   • No external package dependencies
   • Follows n8n's design guidelines
   • Passes quality and security review

2. Submit through the n8n Creator Portal

Benefits of verification:

• Available directly in n8n Cloud
• Discoverable in the n8n nodes panel
• Verified badge for quality assurance
• Increased visibility in the n8n community

Available Scripts

This starter includes several npm scripts to streamline development:

Script	Description
npm run dev	Start n8n with your node and watch for changes (runs n8n-node dev)
npm run build	Compile TypeScript to JavaScript for production (runs n8n-node build)
npm run build:watch	Build in watch mode (auto-rebuild on changes)
npm run lint	Check your code for errors and style issues (runs n8n-node lint)
npm run lint:fix	Automatically fix linting issues when possible (runs n8n-node lint --fix)
npm run release	Create a new release (runs n8n-node release)

[!TIP]
These scripts use the @n8n/node-cli under the hood. You can also run CLI commands directly, e.g., npx n8n-node dev.

Troubleshooting

My node doesn't appear in n8n

1. Make sure you ran npm install to install dependencies
2. Check that your node is listed in package.json under n8n.nodes
3. Restart the dev server with npm run dev
4. Check the console for any error messages

Linting errors

Run npm run lint:fix to automatically fix most common issues. For remaining errors, check the n8n node development guidelines.

TypeScript errors

Make sure you're using Node.js v22 or higher and have run npm install to get all type definitions.

Resources

• n8n Node Documentation - Complete guide to building nodes
• n8n Community Forum - Get help and share your nodes
• @n8n/node-cli Documentation - CLI tool reference
• n8n Creator Portal - Submit your node for verification
• Submit Community Nodes Guide - Verification requirements and process

Contributing

Have suggestions for improving this starter? Open an issue or submit a pull request!

License

MIT