coder/docs/reference/api/notifications.md

Notifications

Get notification dispatch methods

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/notifications/dispatch-methods \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /notifications/dispatch-methods

Example responses

200 Response

[
  {
    "available": [
      "string"
    ],
    "default": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.NotificationMethodsResponse

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
[array item]	array	false
» available	array	false
» default	string	false

To perform this operation, you must be authenticated. Learn more.

Get notifications settings

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/notifications/settings \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /notifications/settings

Example responses

200 Response

{
  "notifier_paused": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.NotificationsSettings

To perform this operation, you must be authenticated. Learn more.

Update notifications settings

Code samples

# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/notifications/settings \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

PUT /notifications/settings

Body parameter

{
  "notifier_paused": true
}

Parameters

Name	In	Type	Required	Description
body	body	codersdk.NotificationsSettings	true	Notifications settings request

Example responses

200 Response

{
  "notifier_paused": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.NotificationsSettings
304	Not Modified	Not Modified

To perform this operation, you must be authenticated. Learn more.

Get system notification templates

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/notifications/templates/system \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /notifications/templates/system

Example responses

200 Response

[
  {
    "actions": "string",
    "body_template": "string",
    "enabled_by_default": true,
    "group": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "kind": "string",
    "method": "string",
    "name": "string",
    "title_template": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.NotificationTemplate

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
[array item]	array	false
» actions	string	false
» body_template	string	false
» enabled_by_default	boolean	false
» group	string	false
» id	string(uuid)	false
» kind	string	false
» method	string	false
» name	string	false
» title_template	string	false

To perform this operation, you must be authenticated. Learn more.

Send a test notification

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/notifications/test \
  -H 'Coder-Session-Token: API_KEY'

POST /notifications/test

Responses

Status	Meaning	Description	Schema
200	OK	OK

To perform this operation, you must be authenticated. Learn more.

Get user notification preferences

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/notifications/preferences \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /users/{user}/notifications/preferences

Parameters

Name	In	Type	Required	Description
user	path	string	true	User ID, name, or me

Example responses

200 Response

[
  {
    "disabled": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.NotificationPreference

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
[array item]	array	false
» disabled	boolean	false
» id	string(uuid)	false
» updated_at	string(date-time)	false

To perform this operation, you must be authenticated. Learn more.

Update user notification preferences

Code samples

# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/users/{user}/notifications/preferences \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

PUT /users/{user}/notifications/preferences

Body parameter

{
  "template_disabled_map": {
    "property1": true,
    "property2": true
  }
}

Parameters

Name	In	Type	Required	Description
user	path	string	true	User ID, name, or me
body	body	codersdk.UpdateUserNotificationPreferences	true	Preferences

Example responses

200 Response

[
  {
    "disabled": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.NotificationPreference

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
[array item]	array	false
» disabled	boolean	false
» id	string(uuid)	false
» updated_at	string(date-time)	false

To perform this operation, you must be authenticated. Learn more.