Community Nodes

Check for Uniqueness

Browse the existing Community Nodes Library to avoid duplicating functionality. You can find the Community Nodes Library in the Node Explorer's "Community" tab.

Write Clear Documentation

Make it easy for others to use your node:

• Add meaningful descriptions to all inputs and outputs

• Use accurate type definitions

• Include usage examples in the node description

• Mention any external setup steps or dependencies

Follow Security Best Practices

Community nodes should never include sensitive information or unsafe logic. Make sure your code:

• Doesn’t hardcode tokens or secrets

• Avoids unsafe external dependencies

• Handles errors gracefully

Set Node Metadata Thoughtfully

Good metadata improves discoverability:

• Choose a descriptive, readable name

• Write a clear summary of what your node does

• Pick the right key-based or OAuth authentication method based on your node's needs

export default async function ({ videoUrl }: NodeInputs, { auth, logging }: NodeScriptOptions) {
  // this would let you access the key user has selected in the canvas
  const apiKey = auth.getKey();
}

export default async function ({ videoUrl }: NodeInputs, { auth, logging }: NodeScriptOptions) {
  // this would let you access the token for the account user has selected in the canvas
  const { access_token } = await auth.getToken();
}

Test Thoroughly

You're creating something others will rely on so make sure it works:

• Save working examples in your node

• Test with different inputs, edge cases, and error scenarios

• Confirm the output is consistent and correct

1. Open the Node Menu

In the node editor, click the options menu (three dots) and select "Publish to Community."

2. Pass Submission Checks

To maintain quality across the community, your node must:

• Include complete documentation

• Have at least one working example saved

• Pass automated validation checks

These steps ensure your node is usable by others and behaves reliably.

3. Fill Out the Submission Form

You'll be prompted to:

• Confirm the node's name and description

• Specify types for inputs/outputs

• Add notes on setup, authentication, or limitations

4. Review and Approval

After submission, the BuildShip team will review your node. Once approved, it will appear in the Community Nodes Library for everyone to use and remix!