Skip to main content

Setup n8n

Follow these steps to set up the Apex Home n8n Community Node in your n8n instance:

Step 1: Install the Community Node​

  1. Open your n8n instance.
  2. Navigate to Settings → Community Nodes.
  3. Click the Install button.
  4. In the modal box that appears, enter the npm package name: 
    n8n-nodes-apexhome
  5. Confirm the installation. The Apex Home node will now be available in the n8n editor.

Step 2: Configure Credentials​

  1. In the n8n editor, go to Settings → Credentials.
  2. Create a new credential for Apex Home.
  3. Enter the required details to connect to your Apex Home instance (e.g., API key, URL).
  4. Save the credentials.

Step 3: Use the Apex Home Nodes​

  1. Drag and drop the Apex Home Triggers node to start a workflow based on an Apex Home event.
  2. Add Apex Home Actions nodes to perform actions such as sending notifications, managing services, or updating dashboards.
  3. Configure the nodes using the credentials you created earlier.

Step 4: Execute the Workflow​

  1. Once your workflow is set up, click Execute Workflow to test it.
  2. Verify that the workflow triggers and actions are working as expected.

Example Workflow​

  • Trigger: Use the Apex Home Triggers node to listen for an event like user.created.
  • Action: Use the Apex Home Actions node to send a notification or create an user.

Troubleshooting​

  • If the node does not appear, ensure that you have installed the dependencies and restarted n8n.
  • For any issues, refer to the n8n-nodes-apexhome documentation.