Skip to main content
Version: v1.5

Features

Here are some of the highlights of using Secured Signal API.

Message Template

Structure your messages

Message Templates can be used to customize your final message after preprocessing. Look at this complex template for example:

settings:
message:
template: |
{{- $greeting := "Hello" -}}
{{ $greeting }}, {{ @name }}!
{{ if @age -}}
You are {{ @age }} years old.
{{- else -}}
Age unknown.
{{- end }}
Your friends:
{{- range @friends }}
- {{ . }}
{{- else }}
You have no friends.
{{- end }}
Profile details:
{{- range $key, $value := @profile }}
- {{ $key }}: {{ $value }}
{{- end }}
{{ define "footer" -}}
This is the footer for {{ @name }}.
{{- end }}
{{ template "footer" . -}}
------------------------------------
Content-Type: {{ #Content_Type }}
Redacted Auth Header: {{ #Authorization }}

It can extract needed data from the body and headers to then process them using Go's templating library and finally output a message packed with so much information.

Head to Configuration to see how-to use.

Placeholders

Time saving and flexible

Placeholders are one of the highlights of Secured Signal API, these have saved me, and will save many others, much time by, for example, not having to change your phone number in every service separately.

Take a look at the usage.

Field Mappings

Standardize output

Field Mappings are very useful for when your favorite service does not officially support Secured Signal API (or Signal CLI REST API). With this feature you have the power to do it yourself, just extract what's needed and then integrate with any of the other features.

Interested? Take a look.

Field Policies

Field Policies are a great way to disallow specific fields or even disallowing fields with unwanted values. This is really helpful when trying to block certain numbers from using certain tokens, and therefor mitigating risks of unwanted use of a token.

Find more about this feature here.

Rate Limiting

Rate Limiting is used for limiting requests and to stop server overload, because of DDoS attacks, malconfigured clients, or malicious actors.
It ensures fair usage per token by controlling how many requests can be processed within a defined period.

Limit those rates here.

Endpoints

Block unwanted access

Endpoints are used for restricting unauthorized access and for ensuring least privilege.

Let's start blocking then!

IP Filters

IP Filters are used for restricting access to Secured Signal API by blocking or specifically allowing IPs and CIDR ranges.

Configure your mini firewall here.