Create tool
Tools
Create Tool
Tool names are automatically normalized to camelCase (e.g. capture_lead → captureLead). Top-level extraction_parameters, static_parameters, and include_standard_metadata are automatically migrated into payload_config if provided outside it.
POST
Create tool
Webhook tools use one canonical configuration across prompt agents, flow agents, and tests:
- For webhook tools,
descriptionis required because it tells the model when the tool is appropriate. config.urlmust be a final public HTTP(S) endpoint. Local and non-public literal targets are rejected at save time; dispatch also rejects non-public or mixed DNS answers. Redirects are not followed.config.methodsupportsGET,POST,PUT,PATCH, andDELETE;timeout_secondsis 1–60 seconds and defaults to 30.- Request headers must have non-empty names and string values. Routing/framing headers such as
Host,Content-Length,Transfer-Encoding,Connection,Expect,Keep-Alive,Proxy-*,TE,Trailer, andUpgradeare rejected. Authorization and custom content types remain supported. - Payload parameter names are normalized to camelCase. Extraction descriptions are required, and
requireddefaults totruewhen omitted. - Webhook tools are dispatched once.
retry_countis unsupported because automatically replaying an action could duplicate a non-idempotent operation.
Authorizations
Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.
Body
application/json
Example:
"capture_lead"
Available options:
webhook, function Webhook configuration is validated as described below; function-tool configuration is stored as an arbitrary JSON object.
Required and non-empty when type is webhook; optional for function tools.