---
title: "Create a new Notification."
method: POST
path: "/v1/{parent}/notifications"
tags: ["Notifications"]
---

# Create a new Notification.

`POST /v1/{parent}/notifications`

## Path parameters

- `parent` string, required

## Request body

- CreateNotificationBody
  - `notification` Notification
    - `name` string — The resource name of the Notification. Should match the pattern `projects/{project_id}/notifications/{notification_id}`.
    - `display_name` string — A user defined name for the Notification.
    - `notification_type` string — Type of the Notification. Valid Notification types include: query, batch, hl7v2, providermap.
    - `callback_url` string — Callback URL to which messages are sent.
    - `active` boolean — Active status of the Notification; true, if active.
    - `create_time` string, date-time
    - `update_time` string, date-time

## Response `200`

A successful response.

- Notification
  - `name` string — The resource name of the Notification. Should match the pattern `projects/{project_id}/notifications/{notification_id}`.
  - `display_name` string — A user defined name for the Notification.
  - `notification_type` string — Type of the Notification. Valid Notification types include: query, batch, hl7v2, providermap.
  - `callback_url` string — Callback URL to which messages are sent.
  - `active` boolean — Active status of the Notification; true, if active.
  - `create_time` string, date-time
  - `update_time` string, date-time

## Other responses

- `400` — Returned when the request is malformed or missing required fields.
- `401` — Returned when the caller does not have permission to access the resource.
- `404` — Returned when the resource does not exist.
- `429` — Returned when the caller has exceeded the rate limit.
- `500` — Server error

---

[API](https://skmtc.net/particlehealth/apis/particle-health-api.md) · [All operations](https://skmtc.net/particlehealth/apis/particle-health-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/particlehealth/particle-health-api/revisions/5aead0b7515e/schema)