跳到主要内容

WorkflowWebhookConfig

workflowIdstringrequired
workflowNamestringrequired
enabledbooleanrequired
targetstringrequired
resolvedTargetstring | nullnullablerequired
entrypointIdstring

已保存的 Workflow 入口 ID;旧配置会在下一次保存时固化目标版本的默认入口。

allowDraftbooleanrequired
secretMaskedstringrequired
secretstring
headerNamestringrequired
Example: x-workflow-webhook-secret
mapping object[]required
  • Array [
  • bodyPathstringrequired
    inputNamestringrequired
  • ]
  • filters object[]required

    Empty array allows all requests. Otherwise any group may match, and all conditions inside a group must match.

  • Array [
  • conditions object[]required
  • Array [
  • bodyPathstringrequired

    Webhook JSON body path. Use $ for the full body.

    operatorstringrequired

    Possible values: [equals, not_equals, contains, starts_with, ends_with, matches, in, exists, missing]

    valuestring

    Required for equals/not_equals/contains/starts_with/ends_with/matches.

    valuesstring[]

    Required for the in operator.

  • ]
  • ]
  • webhookUrlstring | nullnullablerequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    WorkflowWebhookConfig
    {
    "workflowId": "string",
    "workflowName": "string",
    "enabled": true,
    "target": "string",
    "resolvedTarget": "string",
    "entrypointId": "string",
    "allowDraft": true,
    "secretMasked": "string",
    "secret": "string",
    "headerName": "x-workflow-webhook-secret",
    "mapping": [
    {
    "bodyPath": "string",
    "inputName": "string"
    }
    ],
    "filters": [
    {
    "conditions": [
    {
    "bodyPath": "string",
    "operator": "equals",
    "value": "string",
    "values": [
    "string"
    ]
    }
    ]
    }
    ],
    "webhookUrl": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }