v3

latestOpenAPI 3.1.02026-08-087684214.2 KB
webhooks

Test Webhook

Send a test webhook to verify the endpoint is working.

Sends a fake message payload to the configured URL. Pass ?agentId=... to control which agent appears in the payload; otherwise the first agent in the account is used.

post/v1/webhooks/test

Query parameters

agentIdstring nullable

Agent ID to include in the test payload

Agent ID to include in the test payload

Response

Successful Response

{"stackTrail":"paths:/v1/webhooks/test:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}