WorkflowWebhookConfigResponse

errCodeintegerrequired

Constant value: 0

errMessagestringrequired

Constant value:

data objectrequired

workflowIdstringrequired

workflowNamestringrequired

enabledbooleanrequired

targetstringrequired

resolvedTargetstring | nullnullablerequired

entrypointIdstring

The saved Workflow portal ID; the old configuration will solidify the default portal of the target version on the next save.

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

WorkflowWebhookConfigResponse

{
  "errCode": 0,
  "errMessage": "string",
  "data": {
    "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"
  }
}