Pingram Notifications

Note

Pingram is the rebrand of NotificationAPI. If you signed up before the rebrand and still have a clientId/clientSecret pair, that integration is retired: this plugin only accepts a Pingram API key. Your old credentials may still work if you call the Pingram API directly, but they are no longer supported through Apprise.

Overview

• Source: https://www.pingram.io
• Image Support: Yes
• Attachment Support: No
• Message Character Limits:
  • Body: 160
• Build Your Apprise URL

Account Setup

Pingram lets you trigger email, SMS, calls, push, and in‑app notifications using a single API. The Apprise plugin supports the US, CA, and EU regional hosts. Configure the content once in Pingram, then trigger it from Apprise by sending the notification type and recipient information, with optional merge‑tag parameters.

1. Create a Pingram account and sign in at app.pingram.io.
2. In your Environment settings, open the API Keys section and create a Secret Key (server‑to‑server) or Public Key. It will look like pingram_sk_AbCdEf012345 or pingram_pk_AbCdEf012345.
3. Create or identify the notification type you want to trigger (for example, order_tracking).
4. Make sure your recipients have the correct identifiers:
   • Email notifications require an email address on the to object.
   • SMS notifications require a phone number in E.164 format, for example +15005550006.
   • You can also address users by a Pingram user id, but this is always optional; an email or phone number alone is enough to identify a recipient.
5. If you are hosted outside the US, note your region’s API host (US default, CA, or EU).

Syntax

Valid syntax is as follows:

• pingram://{ApiKey}/{Target}
• pingram://{Type}@{ApiKey}/{Target}

Targets can be combined in a single path. Each {Target} segment may be:

• a user id (userid or @userid) — always optional
• an email (name@example.com)
• an E.164 phone number (+15551234567)

A recipient id is never required to accompany an email or phone number; a bare email or phone number is enough on its own to identify a new recipient. If you supply one anyway, it is paired with the very next email/phone number in the path:

• test@example.com → email only, no id
• userid/test@example.com → id + email
• userid/+15551234567 → id + SMS
• +15551234567/test@example.com → two separate recipients (SMS, then email)

Parameter Breakdown

Variable	Required	Description
type	No	Notification type id from your Pingram dashboard. Defaults to apprise.
mode	No	Notification mode; can be either message or template. Defaults to message.
apikey	Yes*	Your Pingram API key (pingram_sk_... or pingram_pk_...). Required unless supplied in the path.
to	No	Comma‑separated list of additional targets.
region	No	us (default), ca, or eu to select the API host.
channels	No	Channels are detected based on the first target detected. The following channels can be provided: email, sms, inapp, web_push, mobile_push, slack and/or call.
from	No	Display name for the email From identity.
cc	No	Comma‑separated list of CC addresses.
bcc	No	Comma‑separated list of BCC addresses.
:{key}	No	Dynamic template parameter tokens passed to parameters (e.g., :orderId=123). It’s important to prefix each one of these with a colon (:) for it to be correctly interpreted. This is only used if mode is set to template

* Required when not already set in the URL path component.

Pingram Default Parameters

Each Pingram request sent through Apprise includes the following default parameters:

Parameter	Description
appBody	The main message body payload of the notification.
appTitle	The message title or subject line.
appType	The Apprise notification type (e.g., info, success, warning, failure).
appId	The Apprise application identifier, usually apprise.
appDescription	The description text configured for the Apprise service.
appColor	A colour code associated with the notification type (used by some channels for visual context).
appImageUrl	A URL pointing to an icon image representing the notification type.
appUrl	A URL reference back to the source application (if configured).

These parameters are always included by Apprise in addition to any custom :{key}={value} tokens you provide in your URL.

These defaults are common across all Apprise plugins, in addition to the service‑specific parameters described above.

Global Parameters

Variable	Description
overflow	This parameter can be set to either split, truncate, or upstream. This determines how Apprise delivers the message you pass it. By default this is set to upstream 👉 upstream: Do nothing at all; pass the message exactly as you received it to the service. 👉 truncate: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated. 👉 split: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after.
format	This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verify	External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes.
redirect	By default, Apprise will follow HTTP redirects (3xx responses) issued by the remote server, matching the behaviour of the underlying requests library. If you want to prevent custom headers and credentials from being forwarded to destinations that differ from the original URL, set this to no. By default it is set to yes.
cto	This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rto	This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojis	Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tz	Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area.
retry	The number of additional delivery attempts to make after the first failure before giving up. Accepts an integer in the range 0 to 10. The default is 0 (no retries — a single attempt is made). When combined with wait, Apprise pauses the specified number of seconds between each attempt.
wait	The number of seconds to pause between retry attempts. Accepts a decimal value in the range 0.0 to 20.0; integer values are promoted to float automatically. The default is 0.5. This value is only meaningful when retry is greater than zero — a service with retry=0 makes exactly one attempt regardless of the wait value.
optional	When set to yes, a delivery failure for this service is silently absorbed. The overall notify() call still returns True even if this endpoint was unreachable, provided that every required (non-optional) service in the same batch succeeded. Setting this flag does not skip delivery or bypass retry logic — all configured retry attempts are still made before the failure is absorbed. By default this is set to no, meaning every failure is propagated to the caller.

Examples

Send to one email recipient by type and let Pingram pick the channel:

apprise -vv -t "Order Update" -b "Your order shipped." \
   pingram://order_tracking@API_KEY/user@example.com

Send the same notification to multiple recipients using path segments:

apprise -vv -t "Status" -b "Processing complete." \
   pingram://order_tracking@API_KEY/user@example.com/+15552341234/alice_123

Force the SMS channel and set the region to Canada:

apprise -vv -t "Code" -b "Your verification code is 123456" \
   'pingram://order_tracking@API_KEY/+16475550123?channels=sms&region=ca'

Set From, CC and BCC for an email:

apprise -vv -t "Release" -b "v2.0.1 is live." \
   'pingram://release_note@API_KEY/dev@example.ca?from=Dev%20Team&cc=qa@example.ca&bcc=ops@example.ca'

Pass dynamic template tokens that your Pingram template references:

apprise -vv -t "Order" -b " " \
   'pingram://order_tracking@API_KEY/user@example.com?:orderId=12345&:status=shipped&mode=template'

Use a query‑only form, handy in YAML:

apprise -vv -t "Hello" -b "Hi there" \
   'pingram://?apikey=API_KEY&type=greeting&to=user@example.com'

Minimal (a bare email, no id):

apprise -vv -t "Welcome" -b "Hello from Apprise" \
   "pingram://welcome_email@API_KEY/test@example.com"

EU region + token substitutions:

apprise -vv -b "<b>Your order shipped!</b>" --format=html \
   "pingram://order_update@API_KEY/test@example.com?region=eu&:firstName=Chris&:trackingUrl=https://t.example/ABC123&mode=template"

Setting From / CC / BCC / Reply‑To (email):

apprise -vv -b "Body" \
   "pingram://newsletter@API_KEY/test@example.com?from=Team<team@example.com>&cc=dev@example.com&bcc=ops@example.com&reply=help@example.com"