Notification Handlers: Retrieve One

This documentation entry provides a clear and detailed guide on how to retrieve a specific notification handler using the API, including the necessary parameters, headers, and expected response.

Endpoint

GET /api/notification-handler/{notification_handler_id}

Retrieve detailed information about a specific notification handler by its unique identifier.

Request

HTTP Request

GET https://uptimekeep.com/api/notification-handler/{notification_handler_id}

Replace {notification_handler_id} with the ID of the notification handler you wish to retrieve.

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.

Example of a request:

curl --request GET \
--url 'https://uptimekeep.com/api/notification-handler/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}'

Response

A successful response returns a JSON object containing detailed information about the specified notification handler.

Response Example

{
    "data": {
        "id": 1,
        "type": "email",
        "name": "Work email",
        "settings": {
            "email": "[email protected]"
        },
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2021-06-27 22:16:23"
    }
}

Fields

Data Object

Field	Type	Description
id	Integer	Unique identifier for the notification handler.
type	String	Type of the notification handler (e.g., "email", "webhook", "slack").
name	String	Name of the notification handler.
settings	Object	Configuration settings for the notification handler (see below for details).
is_enabled	Boolean	Indicates if the notification handler is currently active.
last_datetime	String	Timestamp of the last notification sent (in YYYY-MM-DD HH:MM:SS format).
datetime	String	Timestamp when the notification handler was created (in YYYY-MM-DD HH:MM:SS format).

Settings Object

Field	Type	Description
email	String	Email address used for the notification (if type is email).
webhook_url	String	URL used for webhook notifications (if type is webhook).
slack_webhook_url	String	Slack webhook URL (if type is slack).

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code, such as 404 Not Found if the notification handler ID does not exist.