Run a webhook brick configuration

POST

/v1/scenario/webhook/run

const url = 'https://example.com/v1/scenario/webhook/run';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"properties":{"request":{"method":"example","url":"example","body":{"data":"example","type":"example","form_values":[{"name":"example","value":"example"}]},"authentication":{"type":"example","basic":{"username":"example","password":"example"},"bearer":{"token":"example"}},"header":{"headers":[{"name":"example","value":"example"}]},"insecure_skip_verify":true,"proxy":{"url":"example"},"attach_call_metadata":true,"timeout":1},"options":{"async":true,"timeout":1},"response_mapping":{"variables":[{"name":"example","source":"example","path":"example","set_if_not_found":"example"}]}},"storage":{"additionalProperty":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/scenario/webhook/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "properties": { "request": { "method": "example", "url": "example", "body": { "data": "example", "type": "example", "form_values": [ { "name": "example", "value": "example" } ] }, "authentication": { "type": "example", "basic": { "username": "example", "password": "example" }, "bearer": { "token": "example" } }, "header": { "headers": [ { "name": "example", "value": "example" } ] }, "insecure_skip_verify": true, "proxy": { "url": "example" }, "attach_call_metadata": true, "timeout": 1 }, "options": { "async": true, "timeout": 1 }, "response_mapping": { "variables": [ { "name": "example", "source": "example", "path": "example", "set_if_not_found": "example" } ] } }, "storage": { "additionalProperty": "example" } }'

Executes a webhook brick configuration against the supplied test variables and returns the raw outcome. Stored scenario state is never touched. A configuration that cannot be reached — or answers 300 or above — is a 200 carrying status: "fail"; only an invalid configuration is an error response.

Authorizations

bearerAuth

Request Body^required

application/json

object

properties

required

object

request

object

method

string

url

string

body

object

data

string

type

string

form_values

Array<object>

object

name

string

value

string

authentication

object

type

string

basic

object

username

string

password

string

bearer

object

token

string

header

object

headers

Array<object>

object

name

string

value

string

insecure_skip_verify

boolean

proxy

object

url

string

attach_call_metadata

boolean

timeout

number format: float

options

object

async

boolean

timeout

number format: float

response_mapping

object

variables

Array<object>

object

name

Target variable, written as a placeholder. Returned unwrapped in variables.

string

/^\{\{[A-Za-z0-9\-_.]+\}\}$/

source

Where the value is read from — body (JSONPath in path) or header (header name in path).

string

path

string

set_if_not_found

string

storage

Test variable values placeholders are compiled against.

object

key

additional properties

string

Example^generated

{
  "properties": {
    "request": {
      "method": "example",
      "url": "example",
      "body": {
        "data": "example",
        "type": "example",
        "form_values": [
          {
            "name": "example",
            "value": "example"
          }
        ]
      },
      "authentication": {
        "type": "example",
        "basic": {
          "username": "example",
          "password": "example"
        },
        "bearer": {
          "token": "example"
        }
      },
      "header": {
        "headers": [
          {
            "name": "example",
            "value": "example"
          }
        ]
      },
      "insecure_skip_verify": true,
      "proxy": {
        "url": "example"
      },
      "attach_call_metadata": true,
      "timeout": 1
    },
    "options": {
      "async": true,
      "timeout": 1
    },
    "response_mapping": {
      "variables": [
        {
          "name": "example",
          "source": "example",
          "path": "example",
          "set_if_not_found": "example"
        }
      ]
    }
  },
  "storage": {
    "additionalProperty": "example"
  }
}

Responses

200

application/json

object

status

required

Outcome the scenario would branch on — processed or fail.

string

error

required

Failure detail; empty when the outcome is processed.

string

variables

required

Variables the response mapping extracted.

object

key

additional properties

string

curl

required

Equivalent curl command reproducing the request.

string

redirects

required

Array<object>

nullable

object

code

required

integer

url

required

string

method

required

string

response

required

The exchange; null when no response was received.

object

http_status_code

required

integer

http_status_text

required

string

headers

required

object

key

additional properties

Array<string>

body

required

string

duration

required

Round-trip duration in milliseconds.

integer

Example^generated

{
  "status": "example",
  "error": "example",
  "variables": {
    "additionalProperty": "example"
  },
  "curl": "example",
  "redirects": [
    {
      "code": 1,
      "url": "example",
      "method": "example"
    }
  ],
  "response": {
    "http_status_code": 1,
    "http_status_text": "example",
    "headers": {
      "additionalProperty": [
        "example"
      ]
    },
    "body": "example",
    "duration": 1
  }
}

400

Invalid request body or parameters

application/json

object

error

required

Stable lower_snake_case usecase code (e.g. scenario_not_found)

string

code

required

Registered machine code — generic ERRxxx by status class (ERR001–ERR020 reserved); entity-prefixed codes (SCN1xx) appear only inside validation details; registry in docs/specifications/error-envelope-design.md, append-only, never renumbered

string

message

required

string

data

Structured details, present only where there is structure to carry: validation failures (topic validation, per-entity errors) and delete conflicts (topic conflict, referencing agents)

object

topic

string

errors

Validation errors keyed by entity

object

scenario

Array<object>

object

code

SCN1xx constructor validation code

string

message

string

summary

string

tree_id

string

node_id

string

output_type

string

duplicate_tree_index

string

duplicate_node_index

string

property

string

invalid_value

string

agents

Ids of the agents referencing the resource a delete was rejected for; first 20 — message carries the total count

Array<string>

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "data": {
    "topic": "example",
    "errors": {
      "scenario": [
        {
          "code": "example",
          "message": "example",
          "summary": "example",
          "tree_id": "example",
          "node_id": "example",
          "output_type": "example",
          "duplicate_tree_index": "example",
          "duplicate_node_index": "example",
          "property": "example",
          "invalid_value": "example"
        }
      ]
    },
    "agents": [
      "example"
    ]
  }
}

401

Missing or invalid credentials

application/json

object

error

required

Stable lower_snake_case usecase code (e.g. scenario_not_found)

string

code

required

string

message

required

string

data

Structured details, present only where there is structure to carry: validation failures (topic validation, per-entity errors) and delete conflicts (topic conflict, referencing agents)

object

topic

string

errors

Validation errors keyed by entity

object

scenario

Array<object>

object

code

SCN1xx constructor validation code

string

message

string

summary

string

tree_id

string

node_id

string

output_type

string

duplicate_tree_index

string

duplicate_node_index

string

property

string

invalid_value

string

agents

Ids of the agents referencing the resource a delete was rejected for; first 20 — message carries the total count

Array<string>

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "data": {
    "topic": "example",
    "errors": {
      "scenario": [
        {
          "code": "example",
          "message": "example",
          "summary": "example",
          "tree_id": "example",
          "node_id": "example",
          "output_type": "example",
          "duplicate_tree_index": "example",
          "duplicate_node_index": "example",
          "property": "example",
          "invalid_value": "example"
        }
      ]
    },
    "agents": [
      "example"
    ]
  }
}

403

Caller has no access

application/json

object

error

required

Stable lower_snake_case usecase code (e.g. scenario_not_found)

string

code

required

string

message

required

string

data

Structured details, present only where there is structure to carry: validation failures (topic validation, per-entity errors) and delete conflicts (topic conflict, referencing agents)

object

topic

string

errors

Validation errors keyed by entity

object

scenario

Array<object>

object

code

SCN1xx constructor validation code

string

message

string

summary

string

tree_id

string

node_id

string

output_type

string

duplicate_tree_index

string

duplicate_node_index

string

property

string

invalid_value

string

agents

Ids of the agents referencing the resource a delete was rejected for; first 20 — message carries the total count

Array<string>

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "data": {
    "topic": "example",
    "errors": {
      "scenario": [
        {
          "code": "example",
          "message": "example",
          "summary": "example",
          "tree_id": "example",
          "node_id": "example",
          "output_type": "example",
          "duplicate_tree_index": "example",
          "duplicate_node_index": "example",
          "property": "example",
          "invalid_value": "example"
        }
      ]
    },
    "agents": [
      "example"
    ]
  }
}

422

Semantic validation failure

application/json

object

error

required

Stable lower_snake_case usecase code (e.g. scenario_not_found)

string

code

required

string

message

required

string

data

Structured details, present only where there is structure to carry: validation failures (topic validation, per-entity errors) and delete conflicts (topic conflict, referencing agents)

object

topic

string

errors

Validation errors keyed by entity

object

scenario

Array<object>

object

code

SCN1xx constructor validation code

string

message

string

summary

string

tree_id

string

node_id

string

output_type

string

duplicate_tree_index

string

duplicate_node_index

string

property

string

invalid_value

string

agents

Ids of the agents referencing the resource a delete was rejected for; first 20 — message carries the total count

Array<string>

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "data": {
    "topic": "example",
    "errors": {
      "scenario": [
        {
          "code": "example",
          "message": "example",
          "summary": "example",
          "tree_id": "example",
          "node_id": "example",
          "output_type": "example",
          "duplicate_tree_index": "example",
          "duplicate_node_index": "example",
          "property": "example",
          "invalid_value": "example"
        }
      ]
    },
    "agents": [
      "example"
    ]
  }
}

500

Internal server error

application/json

object

error

required

Stable lower_snake_case usecase code (e.g. scenario_not_found)

string

code

required

string

message

required

string

data

Structured details, present only where there is structure to carry: validation failures (topic validation, per-entity errors) and delete conflicts (topic conflict, referencing agents)

object

topic

string

errors

Validation errors keyed by entity

object

scenario

Array<object>

object

code

SCN1xx constructor validation code

string

message

string

summary

string

tree_id

string

node_id

string

output_type

string

duplicate_tree_index

string

duplicate_node_index

string

property

string

invalid_value

string

agents

Ids of the agents referencing the resource a delete was rejected for; first 20 — message carries the total count

Array<string>

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "data": {
    "topic": "example",
    "errors": {
      "scenario": [
        {
          "code": "example",
          "message": "example",
          "summary": "example",
          "tree_id": "example",
          "node_id": "example",
          "output_type": "example",
          "duplicate_tree_index": "example",
          "duplicate_node_index": "example",
          "property": "example",
          "invalid_value": "example"
        }
      ]
    },
    "agents": [
      "example"
    ]
  }
}

Run a webhook brick configuration

Authorizations

Request Bodyrequired

Examplegenerated

Responses

200

Examplegenerated

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

422

Examplegenerated

500

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated