WPPConnect Action

Houses configurations per agent for whatsapp api communications provided by WPPConnect API.

WPPConnect Action

GitHub release (latest by date) GitHub Workflow Status GitHub issues GitHub pull requests GitHub

JIVAS action wrapper for WhatsApp API communications using the WPPConnect API.

Package Information

Name: jivas/wppconnect_action
Author: V75 Inc.
Architype: WPPConnectAction

Meta Information

Title: WPPConnect Action
Group: core
Type: action

Configuration

Singleton: true

Dependencies

Jivas: ^2.0.0

This action provides a wrapper for WhatsApp API communications using the WPPConnect API. As a core action, it simplifies and streamlines interactions with WhatsApp. The package is a singleton and requires the Jivas library version 2.0.0.

How to Use

Below is detailed guidance on how to configure and use the WPPConnect Action.

Overview

The WPPConnect Action provides an abstraction layer for interacting with WhatsApp via the WPPConnect API. It supports multiple configurations for various use cases, including:

Webhook registration for message handling.
Message broadcasting to multiple recipients.
Integration with WPPConnect for sending text, media, and location messages.

Configuration Structure

To use the WPPConnect Action, you need to set up the following configuration parameters. These specify connection and behavioral details.

Parameter	Type	Description	Default
`api_url`	string	WPPConnect Server URL (e.g., `"https://your-wppconnect-server.com"`)	`""`
`secret_key`	string	WPPConnect Server Secret Key for authentication.	`""`
`token`	string	WPPConnect Server API Key for this session.	`""`
`session`	string	WPPConnect Server Instance ID.	`""`
`base_url`	string	JIVAS Base URL (your application's base URL).	`""`
`webhook_url`	string	JIVAS webhook endpoint for receiving WPPConnect messages.	`""`
`request_timeout`	float	Length of time (in seconds) this action waits for the API to complete a request.	`10.0`
`chunk_length`	int	Maximum length of message to send. Longer texts are split into subsequent messages.	`1024`
`use_pushname`	bool	Use the WhatsApp push name as the user name when set to `True`.	`True`
`ignore_newsletters`	bool	Ignore newsletter messages when set to `True`.	`True`
`ignore_forwards`	bool	Ignore forwarded messages when set to `True`.	`True`

Note:

All parameters should be set according to your WPPConnect Server and JIVAS deployment.
webhook_url should be a publicly accessible endpoint that WPPConnect can POST to, in order to allow for event-driven communication.

Best Practices

Validate your API keys, tokens, and webhook URLs before deploying in production.
Test the webhook registration and sample message flow in a staging environment first.
Adjust chunk_length if you have use cases that involve very long text messages.
Use ignore_newsletters and ignore_forwards to filter out less relevant messages and avoid unnecessary processing.

🔰 Contributing

🐛 Report Issues: Submit bugs found or log feature requests for the wppconnect_action project.
💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

Fork the Repository: Start by forking the project repository to your GitHub account.
Clone Locally: Clone the forked repository to your local machine using a git client.
```
git clone https://github.com/TrueSelph/wppconnect_action
```
Create a New Branch: Always work on a new branch, giving it a descriptive name.
```
git checkout -b new-feature-x
```
Make Your Changes: Develop and test your changes locally.
Commit Your Changes: Commit with a clear message describing your updates.
```
git commit -m 'Implemented new feature x.'
```
Push to GitHub: Push the changes to your forked repository.
```
git push origin new-feature-x
```
Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

🎗 License

This project is protected under the Apache License 2.0. See LICENSE for more information.

0.0.8 → This Version

No information provided

All Changes

0.0.1

Initialized package using jvcli

0.0.2

0.0.3

Enforce ENV VARS in action registration

0.0.4

Major Refactor of WPPConnectAPI, WPPConnectAction and action app.

0.0.5

Added behaviour to handle quoted messages as context in replies
Updated action app, added refinements to make UI more usable

0.0.6

Bugfix: incorrect parameter name
Added ignore forwards setting to ignore forwarded messages by default
Added a timeout setting for WppConnect API requests as a remedy to the sporadic lockout issue with the WPPConnect service