List notification-channels

GET

/notification-channels

• Current canonical versioned path (F3.API.01)

Per-organisation Slack/Teams/Discord webhook channels for ChatOps notifications (F3.CHATOPS.01). webhook_url is stored AES-256-GCM encrypted at rest (same scheme as BYOC cloud-credential) and is never returned by the API — only a masked ‘is_configured’ indicator.

Authorizations

• bearerAuth
• apiTokenAuth

Parameters

Query Parameters

pagination[page]

integer

pagination[pageSize]

integer

filters

Strapi REST filter syntax

object

sort

string

populate

string

Responses

200

OK

object

data

Array

object

name

required

string

channel_type

string

Allowed values: slack teams discord generic_webhook

webhook_url

DEPRECATED plaintext field — retained read-only for pre-encryption legacy rows. New writes always go to encrypted_webhook_url. NEVER returned by the API.

string

encrypted_webhook_url

AES-256-GCM encrypted webhook_url (F3.CHATOPS.01) — same iv:authTag:ciphertext:salt format as BYOC cloud-credential (src/utils/credential-crypto.ts). NEVER returned by the API; decrypted only server-side by webhook-notifier for dispatch.

string

events_filter

Array of subscribed event-type strings. Canonical catalog (F3.CHATOPS.01): ‘billing.payment_failed’, ‘billing.trial_ending’, ‘cloud-instance.provision_failed’, ‘alert.fired’. Empty/null = all events.

enabled

boolean

last_sent_at

string format: date-time

failure_count

integer

organisation

One of:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

documentId

string

id

integer

createdAt

string format: date-time

updatedAt

string format: date-time

publishedAt

string format: date-time

nullable

meta

object

pagination

object

page

integer

pageSize

integer

pageCount

integer

total

integer

401

Missing or invalid authentication

403

Not authorized (tenant scope or capability)