Signal

Interact with Signal CLI API

Actions8

Overview

This node integrates with the Signal CLI API to perform various operations related to Signal messaging, groups, contacts, reactions, and receipts. Specifically, for the Contact - Update operation, it updates the details of a contact in a specified Signal account by modifying the contact's name associated with a given phone number.

Common scenarios where this node is beneficial include automating contact management within Signal accounts, such as updating contact names programmatically based on external data sources or workflows. For example, if you maintain a CRM system and want to keep your Signal contacts synchronized with updated names, this node can be used to update those contacts automatically.

Properties

Name Meaning
Account The identifier of the Signal account where the contact exists and will be updated.
Recipient The phone number of the contact to update.
Name The new name to assign to the contact.

Output

The node outputs a JSON object containing the response from the Signal CLI API after attempting to update the contact. This response typically includes confirmation of the update or any error messages returned by the API.

The output structure is:

{
  "json": {
    // Response data from Signal CLI API for the updateContact method
  }
}

No binary data is produced by this node.

Dependencies

  • Requires access to a Signal CLI API endpoint URL configured via credentials.
  • Needs an API key or authentication token (configured in n8n credentials) to authorize requests to the Signal CLI API.
  • Uses HTTP POST requests with JSON-RPC 2.0 format to communicate with the Signal CLI API.

Troubleshooting

  • Missing API URL: If the Signal CLI API URL is not set in the credentials, the node will throw an error indicating that the URL is missing. Ensure the API URL is correctly configured in the node credentials.
  • Invalid Credentials: Authentication failures may occur if the API key or token is incorrect or expired. Verify credential validity.
  • Incorrect Phone Number Format: The recipient phone number must be valid and registered in the Signal account; otherwise, the update may fail.
  • Empty or Missing Required Fields: The Account and Recipient fields are required. Omitting them will cause errors.
  • API Errors: Any errors returned by the Signal CLI API (e.g., network issues, invalid parameters) will be surfaced as node execution errors. Review the API response for details.

Links and References

Discussion