n8n-nodes-cribwise

This is an n8n community node that enables integration with the CRIBWISE inventory and tool management system.

n8n is a fair-code licensed workflow automation platform.

Installation

Follow the installation guide in the n8n community nodes documentation.

npm Installation

npm install n8n-nodes-cribwise

Manual Installation

1. Navigate to your n8n installation directory
2. Go to the custom nodes folder: ~/.n8n/custom/
3. Clone or copy this repository
4. Install dependencies: pnpm install
5. Build the node: pnpm build
6. Restart n8n

Credentials

CRIBWISE API

To use this node, you need to configure the CRIBWISE API credentials:

Field	Description
Client ID	Your CRIBWISE API Client ID. Obtain this from your CRIBWISE administrator.
Client Secret	Your CRIBWISE API Client Secret. Obtain this from your CRIBWISE administrator.
Authentication URL	The base URL for CRIBWISE authentication API. Default: https://api.cribwise.com/authentication/v1
API Base URL	The base URL for your CRIBWISE API instance. Default: https://api.cribwise.com/integration/v1

The node uses OAuth2 client credentials flow for authentication. The node automatically obtains an access token from the authentication server using your Client ID and Client Secret, then uses this token for all API requests.

Setting Up Credentials

1. In n8n, go to Credentials > New
2. Search for "CRIBWISE API"
3. Enter your Client ID (provided by your CRIBWISE administrator)
4. Enter your Client Secret (provided by your CRIBWISE administrator)
5. Adjust the Authentication URL if using a custom CRIBWISE instance
6. Adjust the API Base URL if using a custom CRIBWISE instance
7. Click Save

The credential test will verify connectivity by:

1. Obtaining an access token from /connect/token using your Client ID and Client Secret
2. Calling the /integrationapi/System/Info endpoint with the access token

Note: The access token is obtained automatically for each workflow execution. Token refresh is handled by the workflow, not the node.

Resources and Operations

Item

Manage inventory items in the CRIBWISE system.

Operation	Description
Create	Create a new item
Delete	Delete an item
Get	Retrieve a specific item by ID
Get Many	Retrieve multiple items with optional filtering
Update	Update an existing item

Create Fields:

• name (required) - Item name
• externalId (required) - External identifier
• type (required) - Item type (Consumable, Durable, Assembly, ExpenseItem)
• description - Item description
• vendorItem - Vendor item details (vendorId, vendorItemNumber, vendorItemDescription)
• manufacturerItem - Manufacturer details (manufacturerId, manufacturerItemNumber, manufacturerItemDescription)

User

Manage users in the CRIBWISE system.

Operation	Description
Create	Create a new user
Delete	Delete a user
Get	Retrieve a specific user by ID
Get Many	Retrieve multiple users with optional filtering
Unlock	Unlock a locked user account
Update	Update an existing user

Create Fields:

• name (required) - Username
• password (required) - User password
• userGroupId (required) - User group assignment
• externalId - External identifier
• email - User email address
• firstName, lastName - User name fields

Order (Unified)

Unified interface for managing both purchase and service orders.

Operation	Description
Create	Create a new order
Delete	Delete an order
Get	Retrieve a specific order by ID
Get Many	Retrieve multiple orders with optional filtering
Update	Update an existing order

Fields:

• orderType (required) - Type of order: "purchase" or "service"
• vendorId (required) - Vendor ID for the order
• stockId (required) - Stock location ID

Purchase Order

Manage purchase orders specifically.

Operation	Description
Create	Create a new purchase order
Get	Retrieve a specific purchase order by ID
Get Many	Retrieve multiple purchase orders
Update	Update an existing purchase order

Service Order

Manage service orders specifically.

Operation	Description
Create	Create a new service order
Get	Retrieve a specific service order by ID
Get Many	Retrieve multiple service orders
Update	Update an existing service order

Vendor

Access vendor information (read-only).

Operation	Description
Get	Retrieve a specific vendor by ID
Get Many	Retrieve multiple vendors

Stock

Access stock location information (read-only).

Operation	Description
Get	Retrieve a specific stock location by ID
Get Many	Retrieve multiple stock locations

Device

Access device information (read-only).

Operation	Description
Get	Retrieve a specific device by ID
Get Many	Retrieve multiple devices

Transaction

Access serialized item instance transactions (read-only).

Operation	Description
Get	Retrieve a specific transaction by ID
Get Many	Retrieve multiple transactions

Location

Manage storage locations.

Operation	Description
Create	Create a new location
Delete	Delete a location
Get	Retrieve a specific location by ID
Get Many	Retrieve multiple locations
Update	Update an existing location

Create Fields:

• name (required) - Location name
• description - Location description
• externalId - External identifier

Usage Examples

Example 1: Get All Items

Retrieve all items from the CRIBWISE inventory:

1. Add a CRIBWISE node to your workflow
2. Select Item as the resource
3. Select Get Many as the operation
4. Enable Return All to retrieve all items
5. Execute the workflow

Example 2: Create a New Item

Create a new consumable item:

1. Add a CRIBWISE node to your workflow
2. Select Item as the resource
3. Select Create as the operation
4. Fill in the required fields:
   • Name: "Drill Bit 10mm"
   • External ID: "DB-10MM-001"
   • Type: "Consumable"
5. Optionally add vendor information in the Additional Fields
6. Execute the workflow

Example 3: Sync Users from External System

Import users from another system into CRIBWISE:

1. Use an HTTP Request node or another data source to fetch users
2. Add a CRIBWISE node
3. Select User as the resource
4. Select Create as the operation
5. Map the fields from your data source:
   • Name: {{ $json.username }}
   • Password: {{ $json.initial_password }}
   • User Group ID: {{ $json.department_group_id }}
6. Execute the workflow

Example 4: Create Purchase Order Workflow

Automated purchase order creation:

1. Use a Trigger node (e.g., Webhook or Schedule)
2. Add logic to determine items needing reorder
3. Add a CRIBWISE node:
   • Resource: Order
   • Operation: Create
   • Order Type: Purchase
   • Vendor ID: {{ $json.vendor_id }}
   • Stock ID: {{ $json.stock_id }}
4. Execute the workflow

Example 5: Location Management

Create and manage storage locations:

1. Add a CRIBWISE node
2. Select Location as the resource
3. Select Create as the operation
4. Fill in:
   • Name: "Warehouse A - Shelf 1"
   • Description: "Main warehouse, first shelf"
5. Execute to create the location

Filtering and Pagination

Most "Get Many" operations support:

• Return All: Toggle to retrieve all records (handles pagination automatically)
• Limit: When "Return All" is disabled, specify maximum records to return
• Additional Fields: Filter options specific to each resource

Error Handling

The node includes comprehensive error handling:

• 400 Bad Request: Invalid input data - check required fields
• 401 Unauthorized: Invalid API token - verify credentials
• 403 Forbidden: Insufficient permissions - contact CRIBWISE administrator
• 404 Not Found: Resource doesn't exist - verify IDs
• 429 Too Many Requests: Rate limit exceeded - n8n will retry automatically
• 5xx Server Errors: CRIBWISE server issues - n8n will retry automatically

Enable Continue On Fail in node settings to continue workflow execution even when errors occur.

Compatibility

• n8n version: 0.5.0 or later
• Node.js version: 18.10 or later
• CRIBWISE API: Integration API v1

Resources

• CRIBWISE Website
• CRIBWISE API Documentation
• n8n Community Nodes Documentation

License

MIT