@klicktipp/node-red-contrib-klicktipp v1.0.7

@klicktipp/node-red-contrib-klicktipp

KlickTipp API Integration Nodes for Node-RED

What is the KlickTipp Marketing Suite?

KlickTipp Marketing Suite is a digital marketing platform that empowers creators and small businesses to generate leads and turn them into passionate customers. It boosts growth with GDPR-compliant tools for email and SMS marketing, marketing automation, landing pages, and conversion rate optimization.

This package provides a set of nodes for interacting with the KlickTipp API, allowing you to manage contacts, tags, subscription processes, and more directly from Node-RED. For more detailed information on the KlickTipp API, including available functions for managing contacts, tags, fields, and more, please refer to the official KlickTipp API client documentation.

Table of Contents

• Installation
• Nodes Overview
  • KlickTipp config
  • Contact
  • Contact Tagging
  • Data Field
  • Opt-In Process
  • Tag
  • Triggers
• Credentials
• Error Handling
• License
• Example Flows

Installation

To install the package, run the following command in your Node-RED directory:

npm install @klicktipp/node-red-contrib-klicktipp

Nodes Overview

This package includes various nodes to interact with the KlickTipp API. Below is an overview of the available nodes and their functions:

KlickTipp Config

• Node Name: klicktipp-config
• Description: This is a configuration node used to store your KlickTipp API credentials (username and password). You will use this node to authenticate other KlickTipp nodes.

Contact

• Node Names::
  • Add or update contact
  • Delete contact
  • Get contact
  • Get contact id
  • List contacts
  • List tagged contacts
  • Unsubscribe contact
  • Update contact
• Description: Provides management capabilities for contacts, such as searching, updating, and deleting contact data.

Contact Tagging

• Node Names::
  • Tag contact
  • Untag contact
• Description: Provides management capabilities for contacts tagging.

Data Field

• Node Names::
  • Get data field
  • List data fields
• Description: Manages data fields, including retrieving all available data fields for contacts, and obtaining data field information.

Opt-in Process

• Node Names::
  • Get opt-in process
  • Get redirect url
  • list opt in process
• Description: Manages opt-in processes, including listing all processes, retrieving details of a specific process, and obtaining redirect URLs.

Tag

• Node Names::
  • Create tag
  • Delete tag
  • Get tag
  • List tags
  • Update tag
• Description: Manages tags within KlickTipp, enabling operations to list, create, update, and delete tags.

Triggers

• Node Name:: Watch new events
• Description: Triggers on a new event.

Credentials

To use the KlickTipp nodes, you need to configure your API credentials using the klicktipp-config node. The required credentials are:

• Username
• Password

Once configured, all requests made using other KlickTipp nodes will authenticate using this configuration.

Error Handling

Each node in this package uses built-in error handling to capture issues with API requests. On failure, the following information will be provided in the message:

• msg.error: A description of the error that occurred.
• msg.payload: An object containing success: false if the request failed.

Nodes will continue to send output regardless of success or failure, allowing you to handle the error downstream.

License

This package is licensed under the MIT License. See the LICENSE file for more details.

Example Flows

For detailed examples, please refer to the examples/node-red-contrib-klicktipp.json file.