After a User Is Followed
Feature Description
The App backend can view the user's newly-added attention information in real time.
Notes
To enable this webhook, you must configure the webhook URL and enable the corresponding switch for this webhook. For more information on the configuration method, see Webhook Configuration.
During this webhook, the Chat backend initiates an HTTP POST request to the app backend.
After receiving the webhook request, the app backend must check whether the SDKAppID contained in the request URL is the SDKAppID of the app.
For more security considerations, see the Security Considerations section in Webhook Overview.
Webhook Triggering Scenarios
An app user sends an follow request through the client.
The app admin sends an follow request via REST API.
Webhook Triggering Timing
Triggered upon successful follow.
API Calling Description
Sample Request URL
In the following example, the webhook URL configured for the App is
https://www.example.com
. Example:https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform
Request Parameters
Parameter | Description |
https | The request protocol is HTTPS, and the request method is POST. |
www.example.com | Webhook URL. |
SdkAppid | SDKAppID assigned to an application when the application is created in the Chat console. |
CallbackCommand | Fixed as: Follow.CallbackAfterFollowAdd. |
contenttype | The fixed value is: json . |
ClientIP | Client IP address. For example, 127.0.0.1. |
OptPlatform | Client platform. For valid values, see the description of OptPlatform in the Webhook Protocols section of Webhook Overview. |
Sample Requests
{"CallbackCommand": "Follow.CallbackAfterFollowAdd","From_Account": "UserID_001","FollowList": [{"To_Account": "UserID_002"},{"To_Account": "UserID_003"}],"EventTime": 1702018343678}
Request Fields
Field | Type | Description |
CallbackCommand | String | Webhook command. |
From_Account | String | UserID of the user who initiates the follow operation. |
FollowList | Array | Array of user objects whose follow operations succeeded. |
To_Account | String | UserID of the user who succeeds in following. |
EventTime | Integer | Event trigger timestamp, in milliseconds. |
Sample Response
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": ""}
Response Fields
Field | Type | Attribute | Description |
ActionStatus | String | Required | Request processing result: OK: processing is successful. FAIL: processing failure. |
ErrorCode | Integer | Required | Error Code: 0: processing is successful. Non-zero: processing failure. |
ErrorInfo | String | Required | Error message. |