PUT
/
api
/
workflows
/
{workflowName}
/
webhook
保存 Webhook 配置
curl --request PUT \
  --url https://wfapi.yuhe.space/api/workflows/{workflowName}/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "target": "latest",
  "allowDraft": false,
  "resetSecret": false,
  "mapping": [
    {
      "bodyPath": "event.text",
      "inputName": "message"
    }
  ]
}
'
{
  "errCode": 123,
  "errMessage": "<string>",
  "data": {
    "workflowId": "<string>",
    "workflowName": "<string>",
    "enabled": true,
    "target": "<string>",
    "resolvedTarget": "<string>",
    "allowDraft": true,
    "secretMasked": "<string>",
    "headerName": "x-workflow-webhook-secret",
    "mapping": [
      {
        "bodyPath": "<string>",
        "inputName": "<string>"
      }
    ],
    "filters": [
      {
        "conditions": [
          {
            "bodyPath": "<string>",
            "value": "<string>",
            "values": [
              "<string>"
            ]
          }
        ]
      }
    ],
    "webhookUrl": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "secret": "<string>"
  }
}

Authorizations

Authorization
string
header
required

使用 WORKFLOW_SERVER_ADMIN_KEY 或已创建的账号 API Key。

Path Parameters

workflowName
string
required

Body

application/json
enabled
boolean
required
target
string
allowDraft
boolean
resetSecret
boolean
mapping
object[]
filters
object[]

Response

200 - application/json

保存后的 Webhook 配置。

errCode
integer
required
errMessage
string
required
Allowed value: ""
data
object
required