Signal

Interact with Signal CLI API

Actions8

Overview

This node integrates with the Signal CLI API to perform various operations related to Signal messaging, contacts, groups, reactions, and receipts. Specifically, for the Group - Create operation, it allows users to create a new Signal group by specifying an account, group name, and members. This is useful in scenarios where automated workflows need to manage Signal groups dynamically, such as creating discussion groups for teams or communities based on external triggers.

Example use cases:

  • Automatically create a Signal group when a new project starts, adding relevant team members.
  • Set up event-specific Signal groups with participants imported from other systems.

Properties

Name Meaning
Account The Signal account identifier used to perform the operation.
Name The name of the group to be created.
Members Comma-separated list of members (phone numbers) to add to the group upon creation.

Output

The node outputs a JSON object containing the response from the Signal CLI API after attempting to create the group. This typically includes details about the newly created group or error information if the creation failed.

The output structure is:

{
  "json": {
    // Response data from Signal CLI API for the create group request
  }
}

No binary data is produced by this node.

Dependencies

  • Requires access to a running instance of the Signal CLI API, with its URL configured in the node credentials.
  • Needs an API key or authentication token configured via n8n credentials to authorize requests to the Signal CLI API.
  • Uses HTTP POST requests to communicate with the Signal CLI API endpoint /api/v1/rpc.

Troubleshooting

  • Missing API URL: If the Signal CLI API URL is not set in credentials, the node will throw an error indicating this configuration is missing. Ensure the API URL is correctly configured.
  • Invalid Members Format: The members must be provided as a comma-separated string of valid phone numbers. Incorrect formatting may cause the API to reject the request.
  • API Errors: Any errors returned by the Signal CLI API (e.g., invalid account, permission issues) will result in a generic error message "Error interacting with Signal API". Check the API logs or enable debug logging to get more details.
  • Network Issues: Connectivity problems to the Signal CLI API endpoint will cause failures. Verify network access and that the API service is running.

Links and References

Discussion