---
title: "GET /api/v1/config/notifiers/{slug}"
method: GET
path: "/api/v1/config/notifiers/{slug}"
tags: ["Notifier"]
---

# GET /api/v1/config/notifiers/{slug}

`GET /api/v1/config/notifiers/{slug}`

## Path parameters

- `slug` string, required

## Response `200`

A successful response.

- Configv1ReadNotifierResponse
  - `notifier` Configv1Notifier
    - `created_at` string, date-time — Timestamp of when the Notifier was created. Cannot be set by clients.
    - `discard` boolean — If `true`, enables the `discard` integration, which discards all notifications. Cannot be set if another integration is set.
    - `email` NotifierEmailConfig
      - `html` string — The body of the email to send, in HTML format.
      - `text` string — The body of the email to send, in plain text format.
      - `to` string — The email address to send notifications to. Required if including an `email` object in your request body.
    - `name` string, required — The name of the Notifier. You can modify this value after the Notifier is created.
    - `ops_genie` Configv1NotifierOpsGenieConfig
      - `api_key` string — Your Opsgenie API key. Required if including an `ops_genie` object in your request body.
      - `api_url` string — The Opsgenie API URL to send requests to. Required if including an `ops_genie` object in your request body.
      - `description` string — A description of the alert.
      - `details` object — A set of key/value pairs with additional information about the alert. These key/value pairs can include any arbitrary data.
      - `http_config` Configv1NotifierHTTPConfig
        - `basic_auth` Configv1NotifierHTTPConfigBasicAuth
          - `password` string
          - `username` string
        - `bearer_token` string — Sets a token for bearer authentication. Cannot be set if `basic_auth` is set.
        - `proxy_url` string — Your proxy URL. (This parameter is deprecated, and custom proxies are unsupported.)
        - `tls_config` Configv1NotifierHTTPConfigTLSConfig
          - `insecure_skip_verify` boolean — If `true`, disables validation of the server certificate.
      - `message` string — The alert text.
      - `note` string — A note about the alert.
      - `priority` string — The priority level of alert. Possible values are `P1`, `P2`, `P3`, `P4`, and `P5`.
      - `responders` OpsGenieConfigResponder[] — List of responders responsible for notifications.
        - `id` string — The ID of the responder. Cannot be set if `name` or `username` are set.
        - `name` string — The name of the responder. Cannot be set if `id` or `username` are set.
        - `responder_type` 'TEAM' | 'USER' | 'ESCALATION' | 'SCHEDULE'
        - `username` string — The username of the responder. Cannot be set if `id` or `name` are set.
      - `source` string — A backlink to the sender of the notification.
      - `tags` string — A comma-separated list of tags attached to the notifications.
    - `pagerduty` Configv1NotifierPagerdutyConfig
      - `class` string — The class of the event.
      - `client` string — The client identification of the notification sender.
      - `client_url` string — A backlink to the sender of the notification.
      - `component` string — The part or component of the affected system that is broken.
      - `description` string — A description of the incident.
      - `details` object — A set of key/value pairs with additional information about the incident. These key/value pairs can include any arbitrary data.
      - `group` string — A cluster or grouping of services.
      - `http_config` Configv1NotifierHTTPConfig
        - `basic_auth` Configv1NotifierHTTPConfigBasicAuth
          - `password` string
          - `username` string
        - `bearer_token` string — Sets a token for bearer authentication. Cannot be set if `basic_auth` is set.
        - `proxy_url` string — Your proxy URL. (This parameter is deprecated, and custom proxies are unsupported.)
        - `tls_config` Configv1NotifierHTTPConfigTLSConfig
          - `insecure_skip_verify` boolean — If `true`, disables validation of the server certificate.
      - `images` PagerdutyConfigImage[] — Images to attach to the incident.
        - `alt` string
        - `href` string
        - `src` string
      - `links` PagerdutyConfigLink[] — Links to attach to the incident.
        - `href` string
        - `text` string
      - `routing_key` string — Your PagerDuty integration key, if using the PagerDuty integration type `Events API v2`. Cannot be set if `service_key` is set.
      - `service_key` string — Your PagerDuty integration key, if using the PagerDuty integration type `Prometheus`. Cannot be set if `routing_key` is set.
      - `severity` string — The severity of the incident. Possible values: `critical`, `error`, `warning`, or `info`.
      - `url` string — The Pagerduty URL to send API requests to.
    - `skip_resolved` boolean — If `true`, disables notifications for resolved alerts. Cannot be set if `discard` equals `true`.
    - `slack` Configv1NotifierSlackConfig
      - `actions` NotifierSlackConfigAction[]
        - `confirm_field` SlackConfigConfirmationField
          - `dismiss_text` string
          - `ok_text` string
          - `text` string
          - `title` string
        - `name` string
        - `style` string
        - `text` string
        - `type` string
        - `url` string
        - `value` string
      - `api_url` string — Your Slack webhook API URL. Required if including a `slack` object in your request body.
      - `callback_id` string
      - `channel` string — The channel to send notifications to.
      - `color` string
      - `fallback` string
      - `fields` SlackConfigField[]
        - `short` boolean
        - `title` string
        - `value` string
      - `footer` string
      - `http_config` Configv1NotifierHTTPConfig
        - `basic_auth` Configv1NotifierHTTPConfigBasicAuth
          - `password` string
          - `username` string
        - `bearer_token` string — Sets a token for bearer authentication. Cannot be set if `basic_auth` is set.
        - `proxy_url` string — Your proxy URL. (This parameter is deprecated, and custom proxies are unsupported.)
        - `tls_config` Configv1NotifierHTTPConfigTLSConfig
          - `insecure_skip_verify` boolean — If `true`, disables validation of the server certificate.
      - `icon_emoji` string
      - `icon_url` string
      - `image_url` string
      - `link_names` boolean
      - `mrkdwn_in` string[]
      - `pretext` string
      - `short_fields` boolean
      - `text` string
      - `thumb_url` string
      - `title` string
      - `title_link` string
      - `username` string — The user to send notifications to.
    - `slug` string — The unique identifier of the Notifier. If a `slug` isn't provided, one is generated based on the `name` field. You can't modify this field after the Notifier is created.
    - `updated_at` string, date-time — Timestamp of when the Notifier was last updated. Cannot be set by clients.
    - `victor_ops` Configv1NotifierVictorOpsConfig
      - `api_key` string — Your VictorOps API key. Required if including a `victor_ops` object in your request body.
      - `api_url` string — The VictorOps API URL. Required if including a `victor_ops` object in your request body.
      - `custom_fields` object
      - `entity_display_name` string — A summary of the alerted problem.
      - `http_config` Configv1NotifierHTTPConfig
        - `basic_auth` Configv1NotifierHTTPConfigBasicAuth
          - `password` string
          - `username` string
        - `bearer_token` string — Sets a token for bearer authentication. Cannot be set if `basic_auth` is set.
        - `proxy_url` string — Your proxy URL. (This parameter is deprecated, and custom proxies are unsupported.)
        - `tls_config` Configv1NotifierHTTPConfigTLSConfig
          - `insecure_skip_verify` boolean — If `true`, disables validation of the server certificate.
      - `message_type` string — The behavior of the alert. Possible values are `CRITICAL`, `WARNING`, and `INFO`.
      - `monitoring_tool` string — The monitoring tool from which the state message originated.
      - `routing_key` string — Your VictorOps routing key. Required if including a `victor_ops` object in your request body.
      - `state_message` string — A detailed explanation of the alerted problem.
    - `webhook` Configv1NotifierWebhookConfig
      - `http_config` Configv1NotifierHTTPConfig
        - `basic_auth` Configv1NotifierHTTPConfigBasicAuth
          - `password` string
          - `username` string
        - `bearer_token` string — Sets a token for bearer authentication. Cannot be set if `basic_auth` is set.
        - `proxy_url` string — Your proxy URL. (This parameter is deprecated, and custom proxies are unsupported.)
        - `tls_config` Configv1NotifierHTTPConfigTLSConfig
          - `insecure_skip_verify` boolean — If `true`, disables validation of the server certificate.
      - `url` string — Your webhook URL. This URL will be called as a `POST` request. Required if including a `webhook` object in your request body.

## Other responses

- `404` — Cannot read the Notifier because the slug does not exist.
- `500` — An unexpected error response.
- `default` — An undefined error response.

---

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