Skip to main content
POST
Create or refresh a webhook

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

workspace:read

Workspaces, tasks, People, task context, notes, messages, reminders, and pending approvals.

Body

application/json
name
enum<string>
required
Available options:
approval.required,
agent_run.finished,
task.assigned,
task.created,
task.status_changed,
agent_run.started,
task.mentioned
url
string
required
Required string length: 1 - 2048
secret
string
required
Required string length: 1 - 100
workspaceId
string
Required string length: 1 - 64
ttlMs
integer | null
Required range: 0 < x <= 9007199254740991

Response

Success

id
string
required
refreshBefore
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
deliveryStatus
object