Skip to content
logiccloud orchestrate

Create a notification target

POST
/api/v1/notification-targets
curl --request POST \
  --url http://localhost:3000/api/v1/notification-targets \
  --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" }, "enabled": true }'

A WEBHOOK target is assigned a server-generated HMAC-SHA256 signing secret. That secret is returned in THIS response only and is never readable again; replace it with POST /:id/rotate-secret. A client cannot choose the secret (FM-1660).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

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
required

Human-readable target name

string
Example
Ops on-call email
channel
required

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. Values are write-only: responses show the names with a masked value. At most 20; Host, Content-Length, Content-Type, Transfer-Encoding, Connection and the X-Webhook-* headers are reserved.

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

Whether the target receives deliveries

boolean
default: true

Responses

Section titled “Responses”

201

Section titled “201”
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
secret

HMAC-SHA256 signing key for webhook deliveries. Shown once, on creation, and never returned again. Store it in the receiving system to verify X-Webhook-Signature.

object
Example
{
  "name": "Ops on-call email",
  "channel": "EMAIL"
}

400

Section titled “400”

Missing channel-specific field, or a webhook URL pointing at a private, loopback, link-local or in-cluster address