Skip to content
logiccloud orchestrate

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", "email": "ops@example.com", "url": "https://hooks.example.com/services/T000/B000/XXXX", "enabled": true, "headers": { "Authorization": null, "X-Tenant-Token": "new-value" } }'

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

Header Parameters

Section titled “Header Parameters”
x-organization-id
string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Request Bodyrequired

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

Human-readable target name

string
Example
Ops on-call email
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
enabled

Whether the target receives deliveries

boolean
default: true
headers

Replaces the custom headers. A string sets the value, null keeps the stored value of that name, and a name left out is removed. WEBHOOK only.

object
key
additional properties
string
nullable
Example
{
  "Authorization": null,
  "X-Tenant-Token": "new-value"
}

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. Header names with a masked value (********): the values are write-only because they often carry credentials (FM-1660).

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