v24

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-19169310464.0 KB
Hook

Subscribe

Subscribe the current user to a webhook URL. Returns subscription id.

post/hooks/subscribe

Request body

targetUrlstring uri required

The webhook URL to send notifications to

eventsstring[] nullable

List of task events to subscribe to (created, running, completed, failed, cancelled, paused)

servicestring nullable

Service that receives the webhook

Response

Successful Response

idstring uuid required

The subscription ID

urlstring required

The webhook URL

eventsstring[] nullable

List of subscribed events

servicestring nullable

Service that receives the webhook

subscribedboolean required

Whether subscription was successful