Skip to main content
POST
Create a webhook subscription

Authorizations

overlay_session
string
cookie
required

Signed httpOnly browser session cookie.

Body

application/json
url
string<uri>
required
events
enum<string>[]
required
Minimum array length: 1
Available options:
chat.completed,
chat.failed,
automation.finished,
automation.failed
description
string
Maximum string length: 500
enabled
boolean
default:true
accessToken
string
Minimum string length: 1
userId
string
Minimum string length: 1

Response

Successful response. Stable response schemas are documented in workflow guides when available.

Response shape is route-specific and may be backed by @overlay/app-core contracts.