Skip to main content
PATCH
Update

Authorizations

Authorization
string
header
required

An API key from Settings, API Keys. A caller on this machine needs none.

Path Parameters

id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

Body

application/json
name
string
Required string length: 1 - 200
url
string<uri>
events
enum<string>[]
Minimum array length: 1
Available options:
job.created,
job.started,
job.completed,
job.failed,
job.suspended,
job.resumed,
job.removed,
step.started,
step.completed,
step.failed,
task.started,
task.completed,
task.failed,
node.offline,
node.online,
node.error
enabled
boolean

Switching one back on clears the failure count and the reason it stopped

headers
object
filter
object

Narrows a subscription to a pool or an owner. There is deliberately no job id: a per-job subscription is one nothing would reap

secret
string

Rotate the HMAC key. The way back from a lost one, since it is shown once and never read back

Required string length: 16 - 200

Response

The updated subscription

id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

name
string
required
url
string
required
events
enum<string>[]
required
Available options:
job.created,
job.started,
job.completed,
job.failed,
job.suspended,
job.resumed,
job.removed,
step.started,
step.completed,
step.failed,
task.started,
task.completed,
task.failed,
node.offline,
node.online,
node.error
enabled
boolean
default:true
required
failures
integer
default:0
required

Consecutive failed deliveries. A delivery that lands resets it

created_at
integer
required
Example:

1785846207000

headers
object
filter
object

Narrows a subscription to a pool or an owner. There is deliberately no job id: a per-job subscription is one nothing would reap

error
string | null

Why it was switched off, when it switched itself off

last_status
integer | null
last_delivery_at
integer | null
Example:

1785846207000

created_by
string | null