新建Webhook - LigaAI

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

accessToken

string

必需

示例值:

Body 参数application/json

signature

string

令牌/加签

可选

name

string

webhook名称

必需

state

string

可选

启用状态(enabled: 启用, disabled: 禁用)，默认为禁用状态

type

string

必需

webhook类型编码

projectId

integer <int64>

项目编号

必需

eventIds

array[integer <int64>]

监听事项编号列表

可选

url

string

回调地址

必需

示例

{
  "signature": "xxx",
  "name": "xxx",
  "state": "disabled",
  "type": "feiShu",
  "projectId": 1,
  "eventIds": [
    1,
    2
  ],
  "url": "https://xxx.xxx.com/callback"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://ligai.cn/openapi/api/webhook/add' \
--header 'accessToken: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "signature": "xxx",
    "name": "xxx",
    "state": "disabled",
    "type": "feiShu",
    "projectId": 1,
    "eventIds": [
        1,
        2
    ],
    "url": "https://xxx.xxx.com/callback"
}'

返回响应

🟢200成功

*/*

OK

Body

createBy

integer <int64>

创建人

可选

webhookId

integer <int64>

webhook编号

可选

signature

string

令牌/加签

可选

createTime

string <date>

创建时间

可选

name

string

webhook名称

可选

state

string

可选

启用状态(enabled: 启用, disabled: 禁用)

type

string

webhook类型

可选

projectId

integer <int64>

项目编号

可选

url

string

回调地址

可选

events

array [object {5}]

事件监听列表

可选

eventCode

string

事件编码

可选

eventId

integer <int64>

监听事件编号

可选

typeName

string

类型名称

可选

eventName

string

事件名称

可选

typeCode

string

类型编码

可选

示例

{
  "code": "0",
  "data": {
    "createBy": 1,
    "webhookId": 1,
    "signature": "xxx",
    "createTime": 1646301600000,
    "name": "xxx",
    "state": "disabled",
    "type": "dingTalk",
    "projectId": 1,
    "url": "https://xxx.xxx.com/callback",
    "events": [
      {
        "eventCode": "create",
        "eventId": 1,
        "typeName": "xxx",
        "eventName": "xxx",
        "typeCode": "issue"
      }
    ]
  }
}