Channel settings for push tasks

Last updated 10/05/2026

1. Feature overview

The Engage module currently supports four channel types: Webhook channels, Push Notification, Client Channel, and Third-party Platform channels (WeChat, KakaoTalk, Douyin). You can use Webhook channels to connect to channel platforms that your company has built, or use the push notification channels preset in the AE Engage module to integrate common app push platforms. You can also connect client channels by integrating the AE SDK to reach users in your app in real time. For third-party platforms, we support WeChat Mini Program subscription messages, KakaoTalk Brand Message, and Douyin GameCards on the recommendation feed, making it faster and easier to push messages on these platforms.

2. Create a channel

2.1 Webhook channel

On the channel settings page (Settings > Channel Settings), you can create channels and manage existing channels. Management actions include sending tests, turning channels on/off, and editing/deleting channels.

2.1.1 Create a channel

Click +Create channel in the upper-right corner to open the page for creating a Webhook channel.

• Channel Name: The name of the Webhook channel
• URL: The API endpoint that receives pushed messages. You can configure multiple channels with the same URL.
• Custom request headers: When turned on, you can add custom request headers to the requests sent to this URL.
• Push ID: The ID of the target user entity for message pushes. You can select a number or string property from the user properties. When the audience size is estimated, users whose push ID is empty are filtered out (for example, the target user ID for an in-game mail system is the character ID, and the target user ID for an SMS system is the phone number).
• Authentication: You can turn on channel authentication and enter a secret key to prevent unauthorized calls and improve channel security.
• Funnel Setting: After you turn on the touch funnel, you can configure the event names associated with the funnel steps. You can then view the conversion data of the configured steps on the data details page of the operation tasks that use this channel.
• Content Template: You can customize the template of the content that this channel sends to users. Supported field types include Text, Dynamic text, Number, Dropdown Selection, Date, Time, and Array Row. For example, a mail channel can use the Array Row type to configure item content (such as item ID and item quantity).
• Custom Parameters: Add these as required by the channel. These parameters are passed through.

For more technical details about integrating Webhook channels, see the Webhook channel integration guide.

2.1.2 Manage existing channels

• Send Test

A newly created channel is turned off by default. You can send a test first, and turn on the channel after you confirm that messages can be sent successfully.

Click the paper plane button under Action to open the send test dialog, and fill in the information based on the configuration of the selected channel.

Then click View Request to preview whether the request body generated by the system meets the needs of this send test. After you confirm that everything is correct, click Confirm & Send to send the test.

After the operation succeeds, the system also returns whether this send test succeeded, so you can confirm the status or troubleshoot issues.

• Turn channels on/off

  • After a Webhook channel is turned on, you can select it when you create new tasks.
  • After a Webhook channel is turned off, it can't be selected when you create new tasks (it doesn't appear in the drop-down list), running tasks end automatically, and tasks under approval are withdrawn automatically.

• Edit/Delete

You can edit or delete a channel only after it's turned off.

2.2 Push notification

The preset push notification platforms currently include FCM, JPush, and APNs. You can connect the corresponding apps as needed.

2.2.1 FCM

• Channel Name: The name of the FCM channel. Duplicate names are not allowed.
• Push ID: The FCM registration token field of the target user. You need to report the FCM registration token as a user property first.
• Server private key: Upload the FCM server private key file of the project. For how to get the key, see Get an FCM server key.
• Funnel Setting: After you turn on the touch funnel, you can configure the event names associated with the funnel steps. You can then view the conversion data of the configured steps on the data details page of the operation tasks that use this channel.
• Passthrough Parameter: You can add passthrough parameters as needed. Passthrough parameters are mainly used for internal business logic processing or special display requirements in your business-side app.

For reporting the FCM registration token field and configuring the touch funnel, see the FCM push section in the Message push technical integration guide.

2.2.2 JPush

• Channel Name: The custom name of the channel. Duplicate names are not allowed.
• Push ID: The JPush ID field of the target user. You need to report the JPush ID as a user property first.
• AppKey & MasterSecret: The AppKey and MasterSecret of the app registered on the JPush platform. For how to get the JPush app parameters, see Get JPush app integration parameters.
• Funnel Setting: After you turn on the touch funnel, you can configure the event names associated with the funnel steps. You can then view the conversion data of the configured steps on the data details page of the operation tasks that use this channel.
• Passthrough Parameter: You can add passthrough parameters as needed. Passthrough parameters are mainly used for internal business logic processing or special display requirements in your business-side app.

For reporting the JPush ID field and configuring the touch funnel, see the JPush section in the Message push technical integration guide.

2.2.3 APNs

• Channel Name: The custom name of the channel. Duplicate names are not allowed.
• Push ID: The APNs Token field of the target user. You need to report the APNs Token as a user property first.
• Certificate Type: You can configure a P12 or P8 certificate, and choose the production or development environment. For how to get APNs certificates, see Set up APNs push certificates.
• Funnel Setting: After you turn on the touch funnel, you can configure the event names associated with the funnel steps. You can then view the conversion data of the configured steps on the data details page of the operation tasks that use this channel.
• Passthrough Parameter: You can add passthrough parameters as needed. Passthrough parameters are mainly used for internal business logic processing or special display requirements in your business-side app.

For reporting the APNs Token field and configuring the touch funnel, see the APNs push section in the Message push technical integration guide.

2.2.4 Send test

After you configure a channel, you can test how it works directly in Channel Settings. In the action column of the channel, click Send Test (as shown below) to start the channel test.

When you send a test, enter the push ID of the test account used to verify the result (you can use the AE User Look-Up feature to find the test account's Push ID), as well as the title, content, and other information of the notification. The dialog differs slightly between channels: all channels let you set the Jump Mode to Open app, Open Web Page, or Open the specified page, and set the Image URL. The APNs and JPush channels also require you to choose a send environment, Production or Development, and the JPush channel also has an Icon URL. The FCM and APNs dialogs also list the passthrough parameters configured for the channel. Click Confirm & Send to see the result on your phone.

2.3 Client channel

To use client channels, you need to enable the project-level client channel capability and integrate the AE SDK. Contact your account manager to try this feature.

2.3.1 Create a channel

Click +Create channel in the upper-right corner to open the page for creating a client channel.

• Channel Name: The name of the client channel
• Message Type: After the client receives a pushed message, it uses Message Type to distinguish different in-app trigger scenarios. For example, the message type for a "pop-up" can be defined as popup.
• Push ID: The type of target user ID that receives messages. You can select User Properties (number and string properties) or Client Parameters. When the audience size is estimated, users whose push ID is empty are filtered out (for example, the target user ID for an in-game mail system is the character ID, and the target user ID for an SMS system is the phone number).
• Funnel Setting: After you turn on the touch funnel, you can configure the event names associated with the funnel steps. You can then view the conversion data of the configured steps on the data details page of the operation tasks that use this channel. Touch funnel events must carry the passthrough parameters delivered by the operation task. For details, see the touch funnel settings in the Client-triggered SDK integration guide.
• Content Template: You can customize the template of the content that this channel sends to users. Supported field types include Text, Dynamic text, Number, Dropdown Selection, Date, Time, and Array Row. For example, a mail channel can use the Array Row type to configure item content (such as item ID and item quantity).
• Custom Parameters: Add these as required by the channel. These parameters are passed through.

2.3.2 Send test

A newly created channel is turned off by default. You can send a test first, and turn on the channel after you confirm that it's connected. Click the paper plane button in the action column to start the send test.

Client-triggered send tests require a test device. You can select or add a test device in the test device list and turn on Debug mode. For how to turn on Debug mode, see the Client-triggered integration guide.

After you confirm the push content, click Send to start the test, and watch the progress bar. When the progress bar shows that Pull task succeeded, you can check on the device whether the push content was received. The system returns the result of this send test, so you can confirm the status or troubleshoot issues.

2.3.3 Manage channels

• Turn a channel on or off

  • After a client channel is turned on, you can select it when you create new tasks.
  • After a client channel is turned off, it can't be selected when you create new tasks (it doesn't appear in the drop-down list), running tasks end automatically, and tasks under approval are withdrawn automatically.

• Edit or delete a channel

You can edit or delete a channel only after it's turned off.

For more details about integrating client channels, see the Client channel integration guide.

2.4 Third-party platforms (WeChat/KakaoTalk/Douyin)

The Third-party Platform tab currently has three types of channels: WeChat SubscribeMessage, KakaoTalk - Brand Message, and Douyin - GameCard. If you can't find the channel you need in your project, or you need to connect other third-party channels, contact your account manager.

For best practices, see Best practices for integrating WeChat mini game subscription messages.

2.4.1 Application authorization

Use the Application Authorization entry to authorize calls to the WeChat Mini Program's template information.

The same mini program shares one APP ID and APP Secret, so you only need to authorize it once.

Click Application Authorization at the upper right of the Third-party Platform channels to open the page shown. You can customize the Application Name and enter the APP ID and APP Secret of the mini program.

If the information is correct, click Save and Connect, and the system shows Connected.

Once the AppID and AppSecret are verified, the access_token is automatically refreshed every two hours to keep the application connected.

2.4.2 Create a channel

Click + Create channel in the upper-right corner of Third-party Platform - WeChat SubscribeMessage to open the subscription message channel creation page.

• Channel Name: The name of the WeChat subscription message channel

• Select Authorized Application: When you create a channel, you can select an application whose connection is normal, and the channel automatically pulls all available subscription message templates from that application's WeChat backend. If the application's connection is abnormal, check it in Application Authorization first.

• User OpenID: The ID type of the target users who receive the message. You can select a User Properties item (numeric or string property). Users whose push ID is empty are filtered out when the audience size is estimated. For how to report the OpenID, see the technical documentation.

• Mini-program Settings: Settings for the mini program page that opens when users click the subscription message card. These are channel-level parameters and can be overridden at the task level.

  • Mini-program type: formal (release version), developer (development version), or trial (trial version). Defaults to the release version if left blank
  • Mini-program language: zh_CN (Simplified Chinese), en_US (English), zh_HK (Traditional Chinese), or zh_TW (Traditional Chinese). Defaults to zh_CN (Simplified Chinese) if left blank
  • Redirect URL: The page that opens after users click the template card. It must be a page within this mini program. Parameters are supported (for example, index?foo=bar). If left blank, the template doesn't redirect.

• Content Template:

Push messages for WeChat mini games can be delivered to users' WeChat messages only after users subscribe successfully.

After the application is authorized and connected, the channel can use the token to fetch all subscription message templates created in the WeChat backend at once. You can save the templates you need in the channel and select them in operation tasks.

Click Refresh template list to call the API again and get the latest template list for the channel.

• All types supported by content template parameters

The data types of template parameters are defined by the WeChat message template. The parameter types pulled from WeChat prevail.

WeChat data type	Type description	Mapped Engage input method	Description	Parameter length limit
thing.DATA	Thing	Dynamic text	Any combination of Chinese characters, digits, letters, or symbols	20
number.DATA	Number	Numeric	Digits only, decimals allowed	32
letter.DATA	Letter	Text	Letters only	32
time.DATA	Time	Time	24-hour time format (year, month, and day can be added). Time periods are supported; join the two points in time with "~"
date.DATA	Date	Date	Year-month-day format (24-hour time can be added). Time periods are supported; join the two points in time with "~"
symbol.DATA	Symbol	Dynamic text	Symbols only	5
amount.DATA	Amount	Text	1 currency symbol + up to 10 digits, decimals allowed, can end with the Chinese character for yuan	11
phone_number.DATA	Phone number	Text	Digits, symbols	17
car_number.DATA	License plate	Text	Up to 8 characters. The first and last can be Chinese characters; the rest are letters or digits	8
name.DATA	Name	Text	Up to 10 Chinese characters only, or up to 20 letters or symbols only	Chinese characters: 10 Letters: 20
phrase.DATA	Chinese phrase	Text	Up to 5 Chinese characters	5

2.4.3 Manage channels

• Turn a channel on or off

  • After you turn on the channel switch, the channel status is Connected if the application connects successfully. Otherwise, it's Abnormal.
  • After a channel is turned on, you can select it when creating new tasks;
  • After a channel is turned off, it can't be selected for new tasks (it doesn't appear in the drop-down). Running tasks end automatically, and tasks pending approval are withdrawn automatically.

• Edit or delete a channel

You can edit or delete a channel only after it's turned off.

For technical documentation on integrating WeChat subscription message channels, see the WeChat subscription message channel integration guide.

3. Delivery caps

Delivery caps limit the maximum number of pushes that a single user can receive from the same type of channel within a certain period when multiple operation tasks use the same channel. You can set delivery cap rules for each channel type, and turn on delivery caps when you create operation tasks to avoid disturbing users too often.

Go to Settings > Delivery Caps and turn on the switch of a channel to enter edit mode. You can edit the delivery cap rules of the relevant channels as needed (Webhook channels are set individually per channel). Multiple conditions are combined with AND. When you're done, click Save in the upper-right corner. The supported period units are minutes, hours, days, and weeks.