Skip to main content
PATCH
Update Hook

Path Parameters

hook_id
string
required

Body

application/json

Request body for updating a hook (all fields optional).

name
string | null
Required string length: 1 - 200
description
string | null
trigger
ScheduleTriggerConfig · object

Trigger that fires on a cron schedule.

condition
string | null

Updated condition expression (pass '' to clear)

actions
Actions · object[] | null
enabled
boolean | null

Response

Successful Response

Response schema for a single hook.

id
string
required
account_id
string
required
name
string
required
description
string | null
required
trigger
Trigger · object
required
condition
string | null
required
actions
Actions · object[]
required
enabled
boolean
required
last_run_at
string<date-time> | null
required
next_run_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
created_by
string | null
required
cron
string | null

Cron expression (schedule triggers only)

cron_description
string | null

Human-readable cron schedule