Twist Notifications

Overview

• Source: https://twist.com
• Image Support: No
• Attachment Support: No
• Message Character Limits:
  • Body: 1000

Account Setup

Sign in or create an account with the Twist service if you don’t already have one.

The main thing with the Twist service is you always authenticate with an {email} and a {password}. Apprise can work with twist just knowing these two values as well.

Syntax

Valid syntax is as follows:

• twist://{password}:{email}
• twist://{email}/{password}

Note: If not channel is specified then by default the #General channel is messaged.

You can also message one or more channels too:

• twist://{password}:{email}/#{channel}
• twist://{email}/{password}/#{channel}
• twist://{password}:{email}/#{channel1}/#{channel2}
• twist://{email}/{password}/#{channel1}/#{channel2}

Twist always associates your account with a default team. Apprise determines this for you and by default notifies the channels you specify from within it. However, since it is possible to have your login/password associated with more then one Team. You can use the colon (:) as a delimiter to explicitly identify which team/channel you wish to message.

• twist://{password}:{email}/#{team}:{channel}
• twist://{email}/{password}/#{team}:{channel}

Parameter Breakdown

Variable	Required	Description
email	Yes	This is the email address you associated with your Twist account when you signed up.
password	Yes	This is the password you set when you signed up with Twist
channel	No	This is the channel you wish to notify. If you don’t specify one then the #General channel will be used by default from within your default team. You can optionally use a colon (:) placed in front of the channel name to force the message to a specific team (if you are part of more then one).

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.
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.

Examples

Send a Twist notification to the channel #general associated with our default team.

# Assume:
#  - our {email} is test@example.com
#  - our {password} is abc123
#  - The {channel} is #general
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   twist://abc123:test@example.com/#general