Signal

Interact with Signal CLI API

Actions8

Overview

This node integrates with the Signal CLI API to send read or viewed receipts for messages. It is useful in scenarios where you want to programmatically acknowledge message status updates on Signal, such as marking a message as read or viewed by a recipient. For example, after processing an incoming message, you could use this node to send a "read" receipt back to the sender, confirming that their message was seen.

Properties

Name Meaning
Account The Signal account identifier used to send the receipt.
Recipient Phone number or group ID of the recipient who will receive the receipt.
Receipt Type The type of receipt to send; options are: "Read" or "Viewed".
Timestamp The timestamp of the message being receipted (i.e., the original message's timestamp).

Output

The node outputs a JSON object containing the response from the Signal CLI API after sending the receipt. This typically includes confirmation details about the receipt sent. The output is structured as:

{
  "json": {
    // Response data from Signal CLI API
  }
}

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 for the Signal CLI API (configured in n8n credentials).
  • Uses HTTP POST requests to communicate with the Signal CLI API.

Troubleshooting

  • Missing API URL: If the Signal CLI API URL is not set in credentials, the node will throw an error indicating this. Ensure the API URL is correctly configured.
  • API Communication Errors: Network issues or incorrect credentials can cause errors when interacting with the Signal API. Verify connectivity and credential correctness.
  • Invalid Parameters: Providing invalid recipient IDs, timestamps, or receipt types may result in API errors. Double-check input values.
  • Error Message: "Error interacting with Signal API" indicates a failure during the API call. Check the API endpoint, credentials, and parameter validity.

Links and References

Discussion