How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Coder Notifications API

The Notifications API from Coder — 13 operation(s) for notifications.

Coder Notifications API is one of 32 APIs that Coder publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Notification. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 16 operations across 13 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://{coderHost}/api/v2.

16 operations 13 paths 15 schemas 1 DELETE7 GET4 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://coder.example.com/api/v2
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Coder Notifications API declares 1 security scheme for authenticating requests. An API key is passed in the header as Coder-Session-Token (CoderSessionToken). By default, every request must be authenticated.

Paths & Operations 16

Across 13 paths, the API surfaces 16 operations — 1 DELETE, 7 GET, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Notifications 16
POST
/api/v2/notifications/custom
Send a custom notification
send-a-custom-notification body → 204400403500
GET
/api/v2/notifications/dispatch-methods
Get notification dispatch methods
get-notification-dispatch-methods → 200
GET
/api/v2/notifications/inbox
List inbox notifications
list-inbox-notifications 4 params → 200
PUT
/api/v2/notifications/inbox/mark-all-as-read
Mark all unread notifications as read
mark-all-unread-notifications-as-read → 204
GET
/api/v2/notifications/inbox/watch
Watch for new inbox notifications
watch-for-new-inbox-notifications 4 params → 200
PUT
/api/v2/notifications/inbox/{id}/read-status
Update read status of a notification
update-read-status-of-a-notification 1 param → 200
GET
/api/v2/notifications/settings
Get notifications settings
get-notifications-settings → 200
PUT
/api/v2/notifications/settings
Update notifications settings
update-notifications-settings body → 200304
GET
/api/v2/notifications/templates/custom
Get custom notification templates
get-custom-notification-templates → 200500
GET
/api/v2/notifications/templates/system
Get system notification templates
get-system-notification-templates → 200500
POST
/api/v2/notifications/test
Send a test notification
send-a-test-notification → 200
GET
/api/v2/users/{user}/notifications/preferences
Get user notification preferences
get-user-notification-preferences 1 param → 200
PUT
/api/v2/users/{user}/notifications/preferences
Update user notification preferences
update-user-notification-preferences 1 param body → 200
POST
/api/v2/users/{user}/webpush/subscription
Create user webpush subscription
create-user-webpush-subscription 1 param body → 204
DELETE
/api/v2/users/{user}/webpush/subscription
Delete user webpush subscription
delete-user-webpush-subscription 1 param body → 204
POST
/api/v2/users/{user}/webpush/test
Send a test push notification
send-a-test-push-notification 1 param → 204

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are codersdk.InboxNotification (10 properties), codersdk.NotificationTemplate (9 properties), codersdk.NotificationPreference (3 properties), codersdk.WebpushSubscription (3 properties). Each schema is shown below with its type and property counts.

codersdk.UpdateUserNotificationPreferences
object
1 property
codersdk.NotificationMethodsResponse
object
2 properties
codersdk.InboxNotificationAction
object
2 properties
codersdk.GetInboxNotificationResponse
object
2 properties
codersdk.ValidationError
object
2 properties 2 required
codersdk.CustomNotificationRequest
object
1 property
codersdk.NotificationsSettings
object
1 property
codersdk.InboxNotification
object
10 properties
codersdk.WebpushSubscription
object
3 properties
codersdk.NotificationPreference
object
3 properties
codersdk.NotificationTemplate
object
9 properties
codersdk.DeleteWebpushSubscription
object
1 property
codersdk.CustomNotificationContent
object
2 properties
codersdk.ListInboxNotificationsResponse
object
2 properties
codersdk.Response
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coder-notifications-api-openapi.yml Raw ↑

Other APIs Coder publishes across the network.

Coder Workspaces API
Coder Templates API
Coder Users API
Coder Workspace Agents API
Coder Enterprise API
Coder Agents API
Coder AI Bridge API
Coder AI Providers API
Coder Applications API
Coder Audit API
Coder Authorization API
Coder Builds API
Where this information came from

This is an independent, third-party profile of Coder Notifications API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.