Install and configure the Asaas node in n8n

Install the official Asaas node, configure your API Key, and run a test operation before creating workflows in Production.

Before you begin

Check the requirements:

During development, use a Sandbox account and API Key.

• Create and manage your API keys
• Learn about the Sandbox environment

1. Install via Community Nodes

In n8n:

1. go to Settings → Community Nodes;
2. click Install a community node;
3. enter the package:

@asaasbr/n8n-nodes-asaas

4. click Install.

After installation, confirm that the Asaas node is available in n8n. If it does not appear, restart the instance and check again.

2. Configure the credential

In n8n:

1. go to Credentials → Add Credential;
2. search for Asaas API;
3. enter the API Key;
4. select the corresponding environment;
5. save the credential.

The main fields are:

Always use the API Key from the same environment selected in the credential.

3. Validate the installation

Create a test workflow:

1. add the Asaas node to the canvas;
2. select the Clientes (Customers) resource;
3. choose the Listar Clientes (List Customers) operation;
4. select the credential you created;
5. execute the node.

Expected result

The operation should return the customers of the account used, without an authentication error.

This result confirms that:

• the node was installed;
• the credential was loaded;
• the environment and the API Key match;
• the workflow can communicate with the Asaas API.

After installation

The node can be part of workflows started manually, by other systems, or by Webhooks.

For example:

%%{init: {"flowchart": {"nodeSpacing": 18,"rankSpacing": 24,"diagramPadding": 4,"padding": 7}}}%%
flowchart TD
    A["Receive a Webhook"] --> B["Execute the Asaas node"]
    B --> C["List customers"]
    C --> D["Evaluate the result"]
    D --> E["Continue the workflow"]

    classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px
    classDef validacao fill:#E0F2FE,stroke:#0284C7,color:#0C4A6E,stroke-width:2px
    classDef sucesso fill:#DCFCE7,stroke:#16A34A,color:#14532D,stroke-width:3px

    class A inicio
    class B,C,D validacao
    class E sucesso

    linkStyle default stroke:#94A3B8,stroke-width:2px

Operations executed by the node follow the same rules, permissions, validations, and limits as the Asaas API.

For features that are not yet available in the official node, use n8n's HTTP Request with the Asaas API.

Manual installation

In a self-hosted n8n installation, the package can also be installed via npm:

npm install @asaasbr/n8n-nodes-asaas

Validate the n8n and Node.js versions before installing or updating the package.

Common errors

Errors returned by the API are also made available to the workflow so they can be handled with n8n features.

Next steps

• Create workflows with the Asaas node
• Create and manage your API keys
• Test your integration in Sandbox
• Understand how Webhooks work
• See the API limits
• See the API Reference