Start a listen session
POST/webhooks/listen
What formfeed listen calls: a session that receives the workspace's webhook events like a registered endpoint and relays them over a WebSocket to the CLI, which forwards them to a local server. Deliveries are signed with the session's secret. Test-environment events only, unless live is set, which needs webhook:manage. The websocket_url is valid for 60 seconds; the session lives while a CLI is connected. At most three sessions per workspace (409 listen_session_limit); a new session of the same key or member ends its previous one. Needs webhook:listen, which new keys do not have by default.
Request
Responses
- 201
- 403
- 409
- 503
- default
The session.
The key lacks webhook:listen, or asks for live without webhook:manage.
listen_session_limit: three sessions are already running in the workspace.
region_unavailable: the relay cannot be reached; retry later.
Error (RFC 9457 problem details).