---
title: "Create a notification"
method: POST
path: "/notifications"
tags: ["Notifications"]
---

# Create a notification

`POST /notifications`

## Request

- Base URL: `https://api.smokeball.com`
- URL: `https://api.smokeball.com/notifications`
- Auth: API key in header `x-api-key` and API key in header `Authorization`

Creates a notification.

## Request body

- NotificationDto
  - `staffId` string, nullable: Staff id to notify.
  - `icon` string, nullable: The icon to display for the notification. Will be validated against the Smokeball icon sets.
  - `iconColor` string, nullable: The icon hex color to display for the notification.
  - `message` string, nullable: The message to display for the notification. Supports basic markdown syntax, such as: ** bold **, -- italic -- Supports basic UI markdown syntax for staff member id, such as [@staffId]
  - `toastyIcon` string, nullable: The toast notification icon to display for the notification.
  - `toastyMessage` string, nullable: The toast notification message to display for the notification.
  - `actionUri` string, nullable: The Smokeball uri to execute when the notification is clicked.

## Response `202`

When request is accepted. Returns a 'Link' object.

- Link
  - `id` string, nullable
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable

## Other responses

- `400`: When an unsupported request is made.

---

[API](https://skmtc.dev/smokeball/apis/smokeball-api.md) - [All operations](https://skmtc.dev/smokeball/apis/smokeball-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smokeball/apis/smokeball-api/revisions/6e350cf667d4?raw)