Notificações Inteligentes is a company founded in 2015, focused on transforming the relationship between businesses and customers through message automation, especially via WhatsApp and other intelligent tools.

With almost 10 years in the market, it is part of Grupo GPM Participações e Tecnologias Ltda, offering robust automated communication solutions for thousands of clients across Brazil.

The mission of Notificações Inteligentes is to empower companies with accessible and intelligent technology, helping them sell more, provide better service, and grow efficiently. The company believes in practical innovation that generates real value from the first customer contact.

The values are centered on:

• Effective and intuitive solutions
• Focus on sustainable growth of client businesses
• Excellence in service and continuous innovation

---

Notificações Inteligentes uses automation technology to transform data into strategic alerts, anticipate risks, automate processes, and ensure no sale is lost due to lack of communication.

The main products and features include:

• GPT Chatbot: Intelligent chatbots using AI for automated interactions.
• Automated Workflows: Automate flows and send messages at the right time to engage leads.
• Intelligent Recovery Tools: Recover lost sales with automatic reminders.
• Ad Platforms: Optimize conversion sending and maximize ad performance.
• Service Center: Centralize customer service, automate responses, and track metrics.
• Chatbot: Provide 24/7 service with chatbots, capture leads, and scale your support.
• Intelligent Lead Management: Store, manage, and track leads in the cloud conveniently.
• Intelligent Redirectors: Redirect leads to multiple active WhatsApp numbers and track the origin.
• Intelligent Notifications: Send automatic notifications and boost engagement.
• Campaigns: Schedule campaigns, segment contacts, and increase your conversions.
• Pipeline Management: Manage your sales funnel and track negotiations in real-time.
• Link Creation (URL Builder): Create trackable URLs and enhance your marketing strategies.

The platform processes thousands of messages daily and is already a national reference in the automated communication segment, with over 15,000 companies served, using the solution to streamline processes, improve customer service, and increase operational efficiency.

---

• Automates and scales customer relationships, preventing lost sales due to lack of communication.
• Increases efficiency and agility for sales, support, and marketing teams.
• Facilitates personalization and monitoring of interactions, enabling faster and safer decisions.
• Offers a variety of integrations with major market platforms, facilitating implementation in any business.
• Operates end-to-end: from first contact to post-sale, including campaigns, notifications, automated service, and more.
• Is nationally recognized, with a high volume of clients and success cases.

---

Notificações Inteligentes is a leading platform in message automation and relationship management via WhatsApp, helping businesses of all sizes sell more, serve better, and grow with practical and intelligent technology.

---

Welcome to the Notificações Inteligentes Custom Node! This guide will help you generate and configure your API Key (Bearer Token) to authenticate and securely use all functionalities of your Custom Node.

1. Open your browser and go to the Notificações Inteligentes website.
2. Click Entrar (Login) and log in with your account.

Ensure you use the correct account that has access to the Organizations you want to manage via API.

---

1. After logging in, click Organizações (Organizations) in the top menu.
2. Select the desired organization.
3. Access Configurações (Settings).
4. Look for the Chave de API (API Key) section.
5. Click Gerar nova chave (Generate new key).

6. A dialog box will be displayed:

• Check the box confirming you have saved the key in a secure location.
• Click Concluir (Finish).

The generated key will be used as the Bearer Token for Custom Node authentication. Attention: Keep this key secure! Do not share it publicly.

---

1. In your integration environment (n8n), open the Custom Node.
2. Locate the Create new Credential / Bearer Token field.

3. Paste the key generated on the Notificações Inteligentes website.
4. Save the settings.

5. If there is any problem with the API key, an error message will appear.

Your Custom Node is now ready to communicate securely with the API.

6. If you have more than one organization, you can add more keys and organize the credentials according to each organization. To make identification easier, simply rename each credential.

---

1. Create a test action in the Custom Node, such as Get All Integrations.
2. Execute the action.
3. If everything is correct, you will see the data returned from the API.

If any authentication error occurs, check if:

• The Bearer Token was copied correctly.
• The key has not expired.
• Your account has permission to access the chosen organization.

---

You can now use your Custom Node to create, edit, delete, or query custom variables securely using your API Key (Bearer Token).

---

• The NI (Notificações Inteligentes) Custom Node is a tool that allows you to integrate and automate some functionalities of your NI account directly into your workflows.
• The central idea is that you can manipulate data from your NI platform (such as Integrations, Leads, Lists, Events, and Variables) using standardized operations (CRUD: Create, Read, Update, Delete). The key to this manipulation are Unique Identifiers (IDs).

• Operation Base: Almost all operations in the Node revolve around an ID.

  • To manage an Integration, you need its ID.
  • To edit a Lead, you need the Lead ID.
  • To add leads to a List, you need the List ID and the Lead IDs.
  • And so on for Variables and Groups.

• Typical Workflow:

  • Search/Search All: You will often start by using an operation like "Get All Integrations" or "Get All Leads" to get a list of items and their respective IDs.
  • Use the ID: Then, you will use this ID in a subsequent operation in the same flow (like "Edit Lead", "Rename an Integration", or "Add Leads to List") to perform the desired action on the specific item.

• Error Handling and Confirmations:

  • Success Confirmation: All creation, editing, and deletion operations are validated by the platform. When successful, they return an explicit confirmation message, ensuring the user that the action was completed as expected.
  
  • Error Handling: In case of failure, the node provides detailed and structured error responses, including:
    • Error Description: A readable message explaining the nature of the problem.
    • HTTP Error Code: The standard status code, allowing efficient technical debugging and the construction of robust conditional logic within the n8n flow.
  • When related to an API-specific rule, in most cases it returns the detailed reason for the error, making it even clearer.
  
  • All errors return the error code. In the example below, it returned 404 (Not Found) because it didn't find any ID related to what we tried to delete in the account.
  

• Additional Data:

  • Besides IDs, the Node allows working with a range of complementary (optional) data to enrich your automations, such as Tags, Custom Variables, Filters, and Relationships.
  • In search fields, for example, where plausible, there is an option to receive additional data in the request.
  • Filters allow filtering of data to be received. You can filter by one or more filters at the same time.
  
  • Include Relationships allows adding more data to be received by the API. More than one option can also be used for the search.
  

In summary, the Node transforms the NI API into visual and intuitive blocks in n8n, where the main currency of operation are IDs, allowing you to build complex and personalized automations to manage your communication and contact base efficiently.

---

The Integration resource allows you to create, search, update, and list integrations connected to your account directly from n8n.

Creates a new integration connecting your platform to the system.

Required Fields:

• Name: Give a friendly name to identify the integration (e.g., "My Shopify Store").
• Platform: Specify the platform (e.g., shopify-next, hotmart-v2, wooocommerce, etc). See the list of supported platforms in the field description. Note: Only integrations created with the api-next platform can add or remove leads from your lead list via the API.

How to use: Select the "Create New Integration" operation, fill in the name and platform, and execute. The integration will be created and listed in your panel.

Lists all integrations already registered in your account.

No fields need to be filled in.

Returns a list with all registered names and platforms.

How to use: Select "Get All Integrations" and execute. You will see the complete list of integrations.

Allows querying the detailed data of a specific integration.

Required Fields:

• ID: The unique identifier of the integration you want to query (you can copy this ID when listing all integrations).

Additional Parameters (optional):

• You can choose to include extra fields in the response, such as "Available Events", "Setup Fields", or "Checklist".
• Just mark the ones you want detailed.

How to use: Select "Get an Integration", enter the ID, select (if desired) any additional parameters, and execute.

Updates the name of an existing integration.

Required Fields:

• ID: The identifier of the integration you want to rename.
• New Name: The new name to display in the panel.

How to use: Select "Edit Integration Name", enter the ID and the new name, and execute.

Permanently removes a Integration from the system.

Required Field:

• Lead ID: Identifier of the integration to be removed.

How to use: Select "Delete Integration", enter the Lead ID, and execute. A confirmation message will be displayed if the operation is successful.

• Name: Integration name (up to 100 characters).
• Platform: Integration platform (consult the list in the field description).
• ID: Unique integration identifier, usually provided when creating or listing integrations.
• Additional Parameters: Check to include extra information in the integration search.

• Use "Get All Integrations" to find the ID of the integration you want to edit or query.
• Always check the required fields (marked with *) before executing.
• For platforms, consult the examples in the field description to avoid typing errors.

Additional information about Integrations in NI

---

The Leads resource allows you to register, search, edit, delete, and manage lists of leads (contacts) on your platform directly from n8n, with support for custom variables, tags, and advanced filters.

Creates a new lead (contact) in the system.

Required Fields:

• Name: Full name of the lead.
• Phone: Phone number, including area code.
• Email: Lead's email address.

Optional Fields:

• Notes: Additional observations about the lead.
• Custom Variables: Allows adding extra personalized variables for each lead (e.g., CPF, date of birth, etc.).
• Tags: Add keywords to group or categorize leads (e.g., "VIP client", "prospect").

How to use: Select "Create Lead", fill in the required fields and, if desired, include notes, tags, or custom variables. Execute to register the lead.

Lists all leads registered in the system.

Optional Fields:

• Filters: Allows filtering by name, phone, email, or tag.
• Include Relationships: Check to bring related data, such as lists, tags or list sources.

How to use: Select "Get All Leads", define the desired filters (or leave blank to list all) and execute.

Returns the complete data of a specific lead from its unique identifier.

Required Fields:

• Lead ID: Enter the ID of the desired lead (can be obtained by listing all).

Optional Fields:

• Include Relationships: Choose to bring related lists or tags.

How to use: Select "Get Lead by ID", enter the Lead ID, and if desired, mark the relationships to include. Execute to see complete details.

Allows updating the data of an existing lead.

Required Fields:

• Lead ID: Identifier of the lead to be edited.
• Name: Updated lead name.

Optional Fields:

• Notes: Update or add observations.
• Custom Variables: Change or add custom variables.
• Email: Updated lead email.

How to use: Select "Edit Lead", enter the ID, update the desired fields, and execute.

Permanently removes a lead from the system.

Required Field:

• Lead ID: Identifier of the lead to be removed.

How to use: Select "Delete Lead", enter the Lead ID, and execute. A confirmation message will be displayed if the operation is successful.

Associates one or more lists with the specified lead.

Required Fields:

• Lead ID: Lead identifier.
• List ID(s): IDs of the lists to associate (e.g., 1234, 5678).

How to use: Select "Add Lists to a Lead", enter the Lead ID and the lists (separated by commas). Execute to associate.

Removes one or more lists associated with the lead.

Required Fields:

• Lead ID: Lead identifier.
• List ID(s): IDs of the lists to remove (e.g., 1234, 5678).

How to use: Select "Remove Lists from a Lead", enter the Lead ID and the list IDs. Execute to remove.

• Custom Variables: Allows adding slug/value pairs to the lead (e.g., slug="cpf", value="123.456.789-00").
• Tags: Keywords for grouping leads, entered as a list.
• Filters: Search fields to filter leads by name, phone, email, or tag.
• Include Relationships: Choose to bring along lists, tags, users, and other information connected to the lead.
• List ID(s): List IDs separated by commas, used to add or remove multiple lists at once.

• Use "Get All Leads" to find a lead's ID.
• For fields like lists, separate IDs by commas and do not use extra spaces.
• The system requires mandatory fields, but take advantage of optional fields to better detail your lead and facilitate automations.
• Custom variables are ideal for your business-specific data.
• Always review data before performing deletion actions, as they are irreversible.

Additional information about Leads in NI

---

The Lead Lists resource allows you to create, search, filter, edit, and manage groups of contacts in your lead system directly from n8n. With this resource, you can automate lead grouping, query detailed data, and perform batch actions.

Returns all contact lists registered in the system, allowing advanced filters.

Optional Fields:

• Include Relationships: Choose to include details like source or lead count in the response.
• Additional Properties: Allows filtering lists that "contain leads".
• Filters: Allows filtering lists by name or type.

How to use: Select "Get All Lists", define desired filters and relationships, and execute to list all available lists.

Creates a new list of contacts/leads.

Required Fields:

• List Name: Define the name of the new list.

Optional Fields:

• Tags: Add keywords to the list to facilitate grouping.
• The type is always created as "dynamic".

How to use: Select "Create List", fill in the name, add tags (optional), and execute to create the list.

Queries the complete data of a specific list from its unique identifier.

Required Field:

• List ID: Enter the identifier of the list you want to query.

Optional Fields:

• Include Source Details: Check to bring details of the list's origin.

How to use: Select "Get List by ID", fill in the ID, and check extra details if desired.

Lists all leads belonging to a specific list.

Required Field:

• List ID: Identifier of the list from which you want to see the leads.

Optional Fields:

• Include Relationships: Check to include details like related lists or list sources.
• Filters: Allows filtering the leads by name, phone, or email within this list.

How to use: Select "List Leads in List", enter the List ID, define filters or relationships, and execute to see all leads in that list.

Adds one or more already registered leads to a specific list.

Required Fields:

• List ID: Identifier of the list that will receive the leads.
• Lead ID(s): IDs of the leads to be added (separate by comma, e.g., 12,34,56).

How to use: Select "Add Leads to List", enter the List ID and the Lead IDs, separated by commas, and execute.

Removes one or more leads from a specific list.

Required Fields:

• List ID: List identifier.
• Lead ID(s): IDs of the leads you want to remove from the list (separate by comma).

How to use: Select "Remove Leads from List", fill in the List ID and the Lead IDs to remove, and execute.

Permanently removes a list from the system.

Required Field:

• Lead ID: Identifier of the list to be removed.

Note: System-generated lists cannot be deleted via the API. Only lists of the dynamic type — that is, lists created separately — can be deleted.

How to use: Select "Delete List", enter the List ID, and execute. A confirmation message will be displayed if the operation is successful.

• Include Relationships: Allows bringing additional details about the list or the leads within it, such as origin and quantity.
• More Properties: Use to filter lists that contain leads.
• Filters (for lists): Filter by list name or type.
• Filters (for leads in the list): Filter leads of a specific list by name, phone, or email.
• Tags: Keywords used to organize and classify lists.
• List ID: Unique code for each contact list.
• Lead ID(s): One or more lead codes to be added or removed from lists (always separated by commas).

• Use "Get All Lists" to quickly find a list's ID.
• To add or remove multiple leads at once, always separate IDs by commas (e.g., 101,102,205).
• Using tags greatly facilitates grouping and future automations.
• Filters allow highly segmented searches and actions, optimizing the management of large lead bases.
• The "List Leads in List" resource is ideal for consulting leads from a specific campaign or segment.

Additional information about Lead Lists in NI

---

The Custom Variable resource allows you to create, search, update, and delete custom variables associated with your organization, facilitating dynamic and personalized configuration of integrations directly in n8n.

Creates a new custom variable for use in integrations or flows.

Required Fields:

• Description: Write a brief description about the use or purpose of the variable.
• Variable Type: Choose the data type: Email, Text, CNPJ, CPF, Integer, Numeric, Multiple Selection, or Option List.

Optional Fields:

• Name: Define a name to identify your variable.

How to use: Select the "Create Custom Variable" operation, fill in name, description, and type, and execute. The variable will be available for other operations and integrations.

Lists all custom variables already registered in your organization, with the option for advanced filters.

Optional Fields:

• Additional Parameters: Check if you want to include extra data such as Organization, Author, Last Edit, or Variable Group.
• Filters:
  • Slug: Search variables by slug (unique variable identifier).
  • Type: Filter by variable type.
  • Variable Group Name: List only variables from a specific group.

How to use: Select "Get All Custom Variables", configure the desired filters (or leave blank to see all), and execute.

Queries details of a specific custom variable by entering its ID.

Required Fields:

• Custom Variable ID: Enter the unique identifier of the variable.

Optional Fields:

• Additional Parameters: Include extra data (Organization, Author, etc.).

How to use: Select "Get Custom Variable by ID", enter the ID, and if desired, mark additional parameters. Execute to get details.

Changes properties of an existing custom variable.

Required Fields:

• Custom Variable ID: Identifier of the variable to be edited.
• Description: New description.
• (Other fields, if implemented in the backend, like group, options, etc.)

How to use: Select "Edit Custom Variable", enter the ID, fill in the new data, and execute.

Permanently removes a custom variable from the system.

Required Fields:

• Custom Variable ID: Identifier of the variable to be removed.

How to use: Select "Delete Custom Variable", enter the ID, and execute. If the deletion is successful, you will receive a success confirmation.

• Name: Identification name of the custom variable.
• Custom Variable ID: Unique identifier of the variable (can be obtained by listing all variables).
• Description: Text explaining the purpose or use of the variable.
• Variable Type: Defines the data format (email, text, CPF, etc.).
• Additional Parameters: Allows including extra data in the search (Organization, Author, Last Edit, Variable Group).
• Variable Group: Filters and grouping by group, useful for large-scale organization.
• Filters: Refine your search by slug, type, or group.
• Slug: Unique identifier of the variable (used in automations and integrations).

• Use "Get All Custom Variables" to discover a variable's ID.
• Fill in the Description field clearly to facilitate maintenance and future use.
• Use appropriate variable types to ensure validation and correct use in your flows (e.g., for CPF, use the "CPF" type).
• Required fields are signaled by the system.
• Deleted variables cannot be recovered.

Additional information about Custom Variables in NI

---

The Custom Variable Groups resource allows organizing custom variables into groups, facilitating the management, search, update, and automation of structured data on your platform via n8n.

Creates a new group to cluster custom variables.

Required Field:

• Name: The name of the new variable group.

How to use: Select "Create Group", enter the group name, and execute to create.

Returns all variable groups registered in the system.

Optional Fields:

• Include Relationships: Check if you want to include extra data such as Organization, Author, or Last Edit.
• Filter: Allows filtering groups by name.

How to use: Select "Get All Groups", mark relationships or define filters if desired, and execute.

Queries the complete data of a specific variable group by its unique identifier.

Required Field:

• Group ID: Enter the identifier of the desired group.

Optional Field:

• Include Relationships: Bring extra information like organization or author.

How to use: Select "Get Group by ID", enter the Group ID, mark the desired relationships, and execute.

Allows changing the name of an existing group.

Required Fields:

• Group ID: Identifier of the group to be changed.
• New Group Name: The new name to be assigned to the group.

How to use: Select "Edit Group Name", enter the ID, the new name, and execute.

Permanently removes a variable group from the system.

Required Field:

• Group ID: Identifier of the group to be removed.

How to use: Select "Delete Group", enter the Group ID, and execute. If the operation is successful, a confirmation message will be displayed.

• Name: Name of the variable group, used in creation.
• Group ID: Unique identifier for each group, used in searches, edits, and removals.
• New Group Name: Used to change the name of an existing group.
• Include Relationships: Allows bringing additional information like Organization, Author, or Last Edit when searching for groups.
• Filter: Filter to search groups by name.

• Use "Get All Groups" to discover a group's ID before editing or removing.
• Take advantage of the relationship function to get context about who created, edited, or belongs to the group's organization.
• Always review names before editing or deleting, as deletion actions cannot be undone.

Additional information about Custom Variables in NI

---

The Events resource allows creating and sending different types of events to integrations, such as: abandoned cart, invoices, payments, cancellations, deliveries, NPS, member access, and password reset, among others. Ideal for automations and intelligent notifications in your flow.

Sends an event to notify about an abandoned shopping cart.

Required Fields:

• Integration ID
• Customer data (name, phone)
• Order products (name, quantity, value)

Optional Field:

• Cart/checkout data (URL, ID)

Notifies that an invoice was generated and printed for the customer.

Required Fields:

• Customer data (name, phone)
• Order data (ID, values, status, discounts, products)

Optional Field:

• Address data

Each event records a different order status, always including:

Required Fields:

• Customer data
• Order data (ID, values, status, discounts, products)
• Payment details (billet, pix, etc.) according to the event type

Optional Field:

• Address and delivery data

Sends access data for members.

Required Fields:

• Customer data
• Member page URL, login, and temporary password
• Products associated with the access

Notifies the customer with the link to reset their password.

Required Fields:

• Customer data
• Password reset URL

Involves two separate events:

Records the score, comment, and date of the customer's satisfaction response after they answer an NPS survey.

Required Fields:

• Customer data
• Score given by the customer
• (Optional: comment and response date)

Sends an event to trigger the NPS survey link to the customer.

Required Fields:

• Customer data
• Survey URL (surveyurl)

• Customer Data: Always include first name, phone, email, CPF/CNPJ, currency, gender, date of birth, IP.
• Products: Name, quantity, and value of products (can add several).
• Address: City, country, neighborhood, number, ZIP code, state, street, complement.
• Order: ID, values (total, discount, products_total), status.
• Delivery: Shipping cost, description, tracking code, tracking URL, estimated delivery date, message.
• Payment (invoice/Pix): Links, codes, values, and specific dates.
• NPS: Score, comment, response date, or survey URL.
• Member Access: URLs, login, password, and access products.
• Password Reset: URL to reset.

• Always fill in all required fields for each operation, respecting suggested formats (e.g., dates, currency).
• For product or address lists, use the "Add product data" or "Additional Parameters" option.
• The system validates: blank required fields block execution!
• In the case of PIX events, check the correct payment method option to show specific fields.
• Grouped fields (like "checkout", "addressparameter", "deliveryparameter") must be expanded to enter detailed data.
• Use the event corresponding to the actual order/action status.

Additional information about Events in NI