Skip to content

EventChannel

Manage event notification channels such as Webhooks, WeChat robots, and DingTalk robots


Replace receive event channel

PUT
/api/v1/event/channel

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json
JSON
{
"id": 1,
"channelType": "WECHAT",
"name": "WeChat Reboot",
"address": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=9e3b6ca1-2d3d-4cc2-8314-153871c7ccaf"
}

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

服务器
授权
主体

示例

cURL
JavaScript
PHP
Python

Add receive event channel

POST
/api/v1/event/channel

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json
JSON
{
"channelType": "WECHAT",
"name": "WeChat Reboot",
"address": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=9e3b6ca1-2d3d-4cc2-8314-153871c7ccaf"
}

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

服务器
授权
主体

示例

cURL
JavaScript
PHP
Python

Test receive event channel

POST
/api/v1/event/channel/test

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json
JSON
{
"channelType": "WECHAT",
"name": "WeChat Reboot",
"address": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=9e3b6ca1-2d3d-4cc2-8314-153871c7ccaf"
}

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

服务器
授权
主体

示例

cURL
JavaScript
PHP
Python

Query the list of receive event channel type

GET
/api/v1/event/channel/type/{channelType}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

channelType*

Receive channel type

类型string
必填
枚举
"WEBHOOK""EMAIL""DINGTALK""WECHAT"

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

服务器
授权
变量

示例

cURL
JavaScript
PHP
Python

Delete receive event channel

DELETE
/api/v1/event/channel/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Event channel id

类型integer
必填
format"int64"

响应

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场

服务器
授权
变量

示例

cURL
JavaScript
PHP
Python

Released under the GPL-3.0 License.