New Webhook - WorkZappy

curl --location --request POST 'https://app.workzappy.com/openapi/api/webhook/add' \ --header 'accessToken: {{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" }'

{ "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" } ] } }

Request

Header Params

Content-Type

string

required

Example:

application/json

accessToken

string

required

Example:

Body Params application/json

signature

string

optional

Token

name

string

required

Webhook Name

state

string

optional

Webhook state(enabled: Enabled, disabled: Disabled), disabled by default

type

string

required

Webhook Type Code

projectId

integer <int64>

required

Project ID

eventIds

array[integer <int64>]

optional

Event ID List

url

string

required

Callback URL

Examples

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), disabled by default

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