Query Webhook List

Request

Header Params

Content-Type

string

required

Example:

application/json

accessToken

string

required

Example:

Body Params application/json

createTimeOrderBy

string

optional

Creation Time Sort (ASC|DESC)

createByIdSet

array[integer <int64>]

optional

Creator ID List

pageNumber

integer <int32>

optional

Page Number

name

string

optional

Webhook Name

pageSize

integer <int32>

optional

Page Size

state

string

optional

Webhook state(enabled: Enabled, disabled: Disabled)

type

array[string]

optional

Webhook type

projectId

integer <int64>

required

Project ID

Example

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://app.leiga.com/openapi/api/webhook/page' \
--header 'accessToken: ' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

application/json

Body

createBy

integer <int64>

optional

Creator ID

webhookId

integer <int64>

optional

Webhook ID

signature

string

optional

Token

createTime

string <date>

optional

Creation Time

name

string

optional

Webhook Name

state

string

optional

Webhook state(enabled: Enabled, disabled: Disabled)

type

string

optional

Webhook Type

projectId

integer <int64>

optional

Project ID

url

string

optional

Callback URL

events

array [object {5}]

optional

Event List

eventCode

string

optional

Event Code

eventId

integer <int64>

optional

Event ID

typeName

string

optional

Event Type Name

eventName

string

optional

Event Name

typeCode

string

optional

Event Type Code

Example

{
  "code": "0",
  "data": {
    "total": 1,
    "list": [
      {
        "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"
          }
        ]
      }
    ]
  }
}