WPUSH Notifications

Overview

• Source: https://wpush.cn/
• Image Support: No
• Attachment Support: No
• Message Character Limits:
  • Body: 10000
• Supported Body Format(s):
  • ✓TEXT
• Build Your Apprise URL

Account Setup

WPUSH sends notifications through WeChat, its App, SMS, Email, DingTalk, Feishu, WeCom, WeChat ClawBot, QQ Robot, and custom Webhooks. It can use several channels in one API call and authenticates with a personal API Key.

1. Register or sign in at WPUSH.
2. Visit the API Key page and copy your key. It always starts with WPUSH followed by 27 more characters (32 total).
3. Visit the Channels page and bind at least one delivery channel before sending your first message.

Your notification URL for the simplest use case is:

wpush://{apikey}

Topic (Broadcast) Sending

WPUSH also supports sending a single notification to everyone subscribed to a named topic.

1. Create a topic and note its topic code from your WPUSH dashboard.
2. Send to the topic to notify all its subscribers.

Place one or more topic codes directly in the URL path:

wpush://{apikey}/{topic}
wpush://{apikey}/{topic1}/{topic2}

When multiple topics are listed, Apprise sends the notification to each one in a separate API call.

Delivery Channels

Notifications use WeChat by default. Select one or more channels with ?channel=:

?channel= value	Channel
wechat	WeChat (default, may be omitted)
app	The WPUSH mobile App
sms	SMS
mail	Email
webhook	Configured webhook endpoint
dingtalk	DingTalk
feishu	Feishu
wechat_work	WeCom (WeChat Work / Enterprise WeChat)
clawbot	WeChat ClawBot
qqbot	QQ Robot

Separate multiple channels with commas. WPUSH uses one API call for all of them:

wpush://{apikey}?channel=mail
wpush://{apikey}/{topic}?channel=feishu
wpush://{apikey}?channel=feishu,dingtalk,wechat_work

Group and Instance Codes

?group= maps to WPUSH’s option field and has two uses:

• With qqbot, it selects a QQ group instead of the account owner.
• With Feishu, DingTalk, WeCom, or Webhook, it selects a bound instance.

wpush://{apikey}?channel=qqbot&group={qq_group_code}
wpush://{apikey}?channel=feishu&group={instance_code}

Find the code on the WPUSH Channels page. Without it, WPUSH uses the account owner or default instance. This option cannot be combined with topic broadcasts.

Click-Through Link

Use ?url= to include a link on supported channels:

wpush://{apikey}?url=https://example.com/

Syntax

Valid syntax is as follows:

• https://api.wpush.cn/api/v1/send?apikey={apikey}
• wpush://{apikey}
• wpush://{apikey}/{topic}
• wpush://{apikey}/{topic1}/{topic2}
• wpush://{apikey}?channel={channel}
• wpush://{apikey}?channel={channel1},{channel2}
• wpush://{apikey}/{topic}?channel={channel}
• wpush://{apikey}?channel=qqbot&group={qq_group_code}
• wpush://{apikey}?url={click_through_url}

Parameter Breakdown

Variable	Required	Description
apikey	*Yes	Your personal WPUSH API Key. Always starts with WPUSH. May also be supplied as ?apikey=.
topic	No	Topic code placed in the URL path. Multiple topics may appear; one API call is made per topic. May also be supplied as ?to=, ?topic=, or ?topic_code=.
channel	No	One or more of wechat (default), app, sms, mail, webhook, dingtalk, feishu, wechat_work, clawbot, qqbot, comma-separated. Supplied as ?channel=.
group	No	QQ group code (qqbot), or a bound instance code for feishu, dingtalk, wechat_work, or webhook. Cannot be combined with a topic. May also be supplied as ?option=.
url	No	An optional click-through link delivered alongside the notification.

Global Parameters

Variable	Description
overflow	Controls messages that exceed a service’s documented limit. The default is upstream. 👉 upstream: Send one message without splitting or truncating it for that limit. 👉 truncate: Keep the portion that fits and discard the rest. 👉 split: Prefer a readable break, fall back to a hard boundary, and send every part in order. Splitting undeclared or structured content is best effort. Use upstream when the body must remain one intact document.
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 evaluates as 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 a simple personal notification:

apprise -vv -t "Title" -b "Hello from Apprise" \
    wpush://WPUSHabc123def456ghi789jkl012mno

Send to a topic:

apprise -vv -t "Team Alert" -b "Deployment complete." \
    wpush://WPUSHabc123def456ghi789jkl012mno/ops-team

Send to two topics at once (one API call per topic):

apprise -vv -t "Broadcast" -b "System maintenance in 30 minutes." \
    wpush://WPUSHabc123def456ghi789jkl012mno/ops-team/dev-team

Deliver via Feishu instead of the default WeChat channel:

apprise -vv -t "Title" -b "Feishu message" \
    "wpush://WPUSHabc123def456ghi789jkl012mno?channel=feishu"

Deliver via three channels at once, in a single API call:

apprise -vv -t "Title" -b "Multi-channel message" \
    "wpush://WPUSHabc123def456ghi789jkl012mno?channel=feishu,dingtalk,wechat_work"

Send to a topic and deliver via email:

apprise -vv -t "Title" -b "Topic email" \
    "wpush://WPUSHabc123def456ghi789jkl012mno/ops-team?channel=mail"

Deliver to a specific QQ group via the QQ Robot channel:

apprise -vv -t "Title" -b "QQ group message" \
    "wpush://WPUSHabc123def456ghi789jkl012mno?channel=qqbot&group=123456789"

Deliver via a specific bound Feishu instance:

apprise -vv -t "Title" -b "Feishu instance message" \
    "wpush://WPUSHabc123def456ghi789jkl012mno?channel=feishu&group=my-instance"

Attach a click-through link to the notification:

apprise -vv -t "Title" -b "See the report" \
    "wpush://WPUSHabc123def456ghi789jkl012mno?url=https://example.com/report"

Use the native WPUSH API URL directly:

apprise -vv -t "Title" -b "Hello" \
    "https://api.wpush.cn/api/v1/send?apikey=WPUSHabc123def456ghi789jkl012mno"