Skip to content
Open
30 changes: 30 additions & 0 deletions source/_integrations/signal_messenger.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,19 @@ url:
description: The URL where the Signal Messenger REST API listens for incoming requests.
required: true
type: string
auth:
description: Configuration for Basic Auth.
required: false
type: map
keys:
username:
description: Username for authentication.
required: true
type: string
password:
description: Password for authentication.
required: true
type: string
number:
description: The sender number.
required: true
Expand All @@ -75,6 +88,23 @@ recipients:
type: string
{% endconfiguration %}

### Basic Auth

If Signal Messenger is running behind a Proxy with Basic Auth requirements, you need to add `auth` to your config and specify the username and password respectively.
Copy link
Author

@CodeShellDev CodeShellDev Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could I add secured-signal-api, as an example?

It is a Proxy made specifically for Signal Messenger REST API

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe add to a separate related projects section?


```yaml
# Basic Auth example for Signal Messenger
notify:
- name: signal
platform: signal_messenger
url: "http://127.0.0.1:8080"
auth:
username: "BASIC_AUTH_USERNAME" # the username to be used for Basic Auth
password: "BASIC_AUTH_PASSWORD" # the password for the specified user
number: "YOUR_PHONE_NUMBER"
recipients:
- "RECIPIENT1"
```

## Notification action

Expand Down