> ## Documentation Index > Fetch the complete documentation index at: https://docs.getcliq.io/llms.txt > Use this file to discover all available pages before exploring further. # Send a test notification > Sends a test notification through a channel (all destinations, or one by `destination_index`) and reports how many were delivered and any errors. Requires a realm operator (or higher) with the `channels.test` permission on the realm that owns the notification channel given by `id`. For an organization-level notification channel, a role with `channels.test` in that organization. ## OpenAPI ````yaml /openapi/hub-by-tag/hub-notification-channels.yaml post /v1/notification_channels/test openapi: 3.0.3 info: title: 'CliqHub API: Notification channels' version: 1.0.0 description: >- Where notifications go. A channel has one or more destinations (Slack, email, a webhook, the CliqHub inbox, or another channel by name) and belongs to an organization or a realm; names are unique within that scope. Notification rules (on Organizations and Realms) decide which events reach which channel. Built-in channels cannot be changed or removed. servers: - url: https://{host} variables: host: default: cliqhub.io description: CliqHub host security: [] tags: - name: Notification channels description: >- Where notifications go. A channel has one or more destinations (Slack, email, a webhook, the CliqHub inbox, or another channel by name) and belongs to an organization or a realm; names are unique within that scope. Notification rules (on Organizations and Realms) decide which events reach which channel. Built-in channels cannot be changed or removed. paths: /v1/notification_channels/test: post: tags: - Notification channels summary: Send a test notification description: >- Sends a test notification through a channel (all destinations, or one by `destination_index`) and reports how many were delivered and any errors. Requires a realm operator (or higher) with the `channels.test` permission on the realm that owns the notification channel given by `id`. For an organization-level notification channel, a role with `channels.test` in that organization. operationId: POST_v1_notification_channels_test requestBody: required: true content: application/json: schema: type: object properties: id: type: string description: Channel id to test destination_index: type: integer description: When set, only fire that destination index (0-based) required: - id examples: default: value: id: 9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b responses: '200': description: Success. content: application/json: schema: type: object required: - ok - data properties: ok: type: boolean enum: - true description: Always `true` on success. data: $ref: '#/components/schemas/NotificationChannelTestData' example: ok: true data: delivered: 1 errors: [] '401': description: >- `unauthorized`: No `Authorization` header, or the token is malformed, expired or revoked. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: unauthorized: summary: unauthorized value: ok: false error: code: unauthorized message: Authentication required '403': description: >- `forbidden`: You can see the record but your role in its realm is too low or lacks the required permission. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: forbidden: summary: forbidden value: ok: false error: code: forbidden message: You do not have access to do this '404': description: >- `not_found`: The notification channel does not exist or is in a realm you cannot see (404 rather than 403, so its existence is not revealed). content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: not_found: summary: not_found value: ok: false error: code: not_found message: Not found '422': description: >- `invalid_params`: The body fails the request schema: a required field is missing or a value has the wrong type or format. The message lists every issue as `field: problem`. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: invalid_params: summary: invalid_params value: ok: false error: 'id: Required' code: invalid_params '500': description: >- `internal_error`: An unexpected server fault. Retry later; if it persists, report it with the time of the request. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: internal_error: summary: internal_error value: ok: false error: Internal server error code: internal_error security: - BearerAuth: [] components: schemas: NotificationChannelTestData: type: object properties: delivered: type: number description: Count of destinations that accepted the synthetic test errors: type: array items: type: string description: Per-destination error messages (empty when all succeeded) required: - delivered - errors HubErr: type: object required: - ok - error description: >- Every failure. Route-policy denials (401/403/404, and 400 when neither realm_id nor org_id was sent) answer `error` as `{ code, message }`; errors raised by the endpoint answer `error` as the message with the code beside it in `code`. Every error has a code. See [Errors](/hub-api/errors). properties: ok: type: boolean description: Always false on error error: description: The message, or `{ code, message }` for an access denial. oneOf: - type: string - type: object required: - code - message properties: code: type: string message: type: string code: type: string description: Stable error code of an endpoint error. details: type: object additionalProperties: true description: Structured detail, when there is some. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: cliq_tok_* | cliq_dt_* description: >- User PAT (`cliq_tok_…`, including session-scoped) or realm token (`cliq_dt_…`). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.