List notification targets

GET

/api/v1/notification-targets

const url = 'http://localhost:3000/api/v1/notification-targets';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/api/v1/notification-targets \
  --header 'X-API-Key: <X-API-Key>'

Lists every notification target in the caller’s organization. Webhook signing secrets are never included — only a boolean indicating whether one is configured.

Authorizations

api-key
bearer

Parameters

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.

Responses

200

application/json

Array<object>

object

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"
  }
]