---
title: "Test Notification Channel"
method: POST
path: "/notifications/channels/{id}/test"
tags: ["Notification Channels"]
---

# Test Notification Channel

`POST /notifications/channels/{id}/test`

Test a notification channel

## Path parameters

- `id` string, objectid, required — ID of the notification channel

## Request body

- TestNotificationChannelInput
  - `locale` 'en' | 'zh' — Locale for the test message
  - `to_mail` string[] — Email addresses to send test mail to (only for mail type)

## Response `200`

OK

- ControllersVoidResponse
  - `error` string
  - `message` string
  - `status` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

## Changes

- **2026-07-17** `c7a4715c1f13` — 1 breaking, 2 warning, 12 info
  - for the `path` request parameter `id`, the type/format was changed from `string`/`` to `string`/`objectid`
  - removed the request property `message`
  - removed the optional property `code` from the response with the `200` status
  - api operation id `test_notification_channel` was added
  - …11 more
- **2025-03-03** `14e4eafea538` — 1 warning
  - removed the optional property `data` from the response with the `200` status
- **2025-03-02** `526e5bdf6dee` — 2 breaking, 4 warning, 10 info
  - request body became required
  - added the pattern `^[0-9a-fA-F]{24}$` to the `path` request parameter `id`
  - removed the request property `locale`
  - removed the request property `to_mail`
  - …12 more

[Change history](https://skmtc.dev/crawlab-team/apis/crawlab-api/changes/notifications/channels/:id/test/post.md)

---

[API](https://skmtc.dev/crawlab-team/apis/crawlab-api.md) · [All operations](https://skmtc.dev/crawlab-team/apis/crawlab-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/crawlab-team/crawlab-api/revisions/c7a4715c1f13/schema)