api.heroui.pro/v1/agents/{agentId}/webhookSend the request to see the live response from the Agents API.
A workspace API key with the permission required by the operation. It may target any active Agent in its workspace.
In: header
1 <= lengthapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://api.heroui.pro/v1/agents/string/webhook" \ -H "Content-Type: application/json" \ -d '{ "enabled": true, "url": "http://example.com" }'{
"saved": true,
"secret": "string"
}{
"message": "limit must be an integer between 1 and 100.",
"name": "bad_request"
}{
"message": "The supplied API key is invalid or revoked.",
"name": "unauthorized"
}{
"message": "string",
"name": "bad_request"
}{
"message": "The requested resource was not found.",
"name": "not_found"
}{
"message": "The knowledge document does not have indexed content yet.",
"name": "conflict"
}{
"message": "Too many requests. Please try again later.",
"name": "rate_limited"
}{
"message": "Internal server error.",
"name": "internal_server_error"
}{
"message": "The API is temporarily unavailable.",
"name": "service_unavailable"
}Queue a test delivery; inspect deliveries to verify its outcome. Owner required. POST
Previous Page
Create a short-lived browser credential from your application server. POST
Existing SDK endpoint: uses X-HeroUI-Agent-Key, camelCase JSON, numeric expiresAt (Unix milliseconds), and {error, code?} errors. Derive identity from your application's trusted session. Never accept an arbitrary identity from the browser. Prefer createAuthToken from @heroui/agent/server.
uri