Skip to main content
POST
Create Webhook Tool

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Console payload minus the folder concept (folders are console-only).

name
string
required
Required string length: 1 - 120
description
string
default:""
Maximum string length: 2000
tool_type
enum<string>
default:webhook
Available options:
webhook,
client
arguments
AgentWebhookArgumentPayload · object[]
method
enum<string>
default:POST
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
url
string
default:""
Maximum string length: 4000
content_type
string
default:application/json
Maximum string length: 128
body_template
string
default:""
Maximum string length: 100000
headers
AgentWebhookHeaderPayload · object[]
timeout_seconds
integer
default:30
Required range: 1 <= x <= 120
error_handling
enum<string>
default:passthrough
Available options:
passthrough,
hide
mock_responses
AgentWebhookMockResponsePayload · object[]
expects_response
boolean
default:true

Response

Document created, URL follows

tool_id
string
required
workspace_id
string
required
name
string
required
tool_type
enum<string>
required
Available options:
webhook,
client
method
enum<string>
required
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
url
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
content_type
string
required
timeout_seconds
integer
required
error_handling
enum<string>
required
Available options:
passthrough,
hide
description
string
default:""
used_by
integer
default:0

How many agents reference this tool in their draft configuration.

arguments
AgentWebhookArgumentPayload · object[]
body_template
string
default:""
headers
PublicToolHeader · object[]
mock_responses
AgentWebhookMockResponsePayload · object[]
expects_response
boolean
default:true