Kook Notifications

Overview

• Source: https://www.kookapp.cn/
• Image Support: No
• Attachment Support: Yes
• Message Character Limits:
  • Bot API: 5000
  • Webhook: 5000
• Build Your Apprise URL

Kook (formerly Kaihei / 开黑啦) is a Chinese gaming-focused communication platform similar to Discord, offering text channels, voice channels, and direct messaging.

Account Setup

Bot Mode (Recommended)

Bot mode gives you full API access including file attachment support.

1. Visit https://developer.kookapp.cn and sign in.
2. Click Create Application and give it a name (e.g. “Apprise”).
3. Under your new application, click Bot in the left sidebar.
4. Click Add Bot and then copy the Token shown on the Bot page.
5. Invite the bot to your server using the OAuth2 page and grant it the required permissions (at minimum: Send Messages).
6. Enable Developer Mode in Kook: Settings → Others → Developer Mode.
7. Right-click any channel and select Copy ID to get its numeric ID.

Webhook Mode

Webhook mode is simpler but does not support file attachments.

1. In Kook, open Server Settings → Integrations → Webhooks.
2. Click Create Webhook for the desired channel.
3. Copy the webhook key from the generated URL (the part after /incoming/).

Syntax

Valid syntax is as follows:

• kook://{token}/{channel_id}
• kook://{token}/{channel_id1}/{channel_id2}/...
• kook://{token}/@{user_id}
• kook://{token}/{channel_id}/@{user_id}
• kook://{webhook_key}?mode=webhook

Note

Prefix a target with @ to send a direct message to a user instead of posting to a channel.

Parameter Breakdown

Variable	Required	Description
token	*Yes	Your bot token (bot mode) or webhook key (webhook mode).
channel_id	No	Numeric channel ID to post to. May be repeated for multiple channels.
user_id	No	Numeric user ID for a direct message. Prefix with @.
mode	No	Operating mode: bot (default) or webhook.

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 a KMarkdown notification to a single channel:

apprise -vv -t "Title" -b "Hello from **Apprise**!" \
    kook://BOT_TOKEN/CHANNEL_ID

Send to multiple channels:

apprise -vv -t "Alert" -b "Message body" \
    kook://BOT_TOKEN/CHANNEL_ID1/CHANNEL_ID2

Send a direct message to a user:

apprise -vv -t "DM" -b "Private message" \
    kook://BOT_TOKEN/@USER_ID

Send via incoming webhook:

apprise -vv -b "Webhook notification" \
    "kook://WEBHOOK_KEY?mode=webhook"

Force plain-text formatting (uses the standard Apprise ?format= parameter):

apprise -vv -b "Plain text message" \
    "kook://BOT_TOKEN/CHANNEL_ID?format=text"