Skip to content
Fleet Manager

Update a notification target

PATCH
/api/v1/notification-targets/{id}
curl --request PATCH \
  --url http://localhost:3000/api/v1/notification-targets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "Ops on-call email", "channel": "EMAIL", "email": "ops@example.com", "url": "https://hooks.example.com/services/T000/B000/XXXX", "headers": { "X-Tenant-Token": "abc123" }, "secret": "example", "enabled": true }'

The channel is immutable — switching transports would leave the stored config mismatched and would retroactively mislabel every delivery already recorded against the target.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name

Human-readable target name

string
Example
Ops on-call email
channel

Delivery transport

string
Allowed values: EMAIL WEBHOOK
email

Recipient address. Required when channel is EMAIL.

string
Example
ops@example.com
url

Endpoint to POST to. Required when channel is WEBHOOK. Must be a public http(s) URL — private, loopback, link-local and in-cluster addresses are rejected to prevent SSRF.

string
Example
https://hooks.example.com/services/T000/B000/XXXX
headers

Extra headers sent on every webhook delivery. WEBHOOK only.

object
key
additional properties
string
Example
{
  "X-Tenant-Token": "abc123"
}
secret

HMAC-SHA256 key used to sign webhook deliveries (X-Webhook-Signature). WEBHOOK only. Generated automatically when omitted — it is returned once on create and never again.

string
enabled

Whether the target receives deliveries

boolean
default: true

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
id
required
string format: uuid
name
required
string
channel
required
string
Allowed values: EMAIL WEBHOOK
email

EMAIL targets only

object
url

WEBHOOK targets only

object
headers

WEBHOOK targets only

object
key
additional properties
string
signed
required

Whether webhook deliveries to this target are signed

boolean
enabled
required
boolean
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "name": "Ops on-call email",
  "channel": "EMAIL"
}

404

Section titled “404”

No such target in the caller’s organization