Notification Handlers: Retrieve All

This documentation entry provides a comprehensive guide to using the "Retrieve All" notification handlers endpoint, including all relevant details about the request, response, and data structures.

Endpoint

GET /api/notification-handler/

Retrieve a list of all notification handlers associated with your account.

Request

HTTP Request

GET https://uptimekeep.com/api/notification-handler/

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.

Query Parameters

Parameter	Type	Description	Default Value
page	Integer	(Optional) The page number to retrieve.	1
results_per_page	Integer	(Optional) Number of results per page. Allowed values: 10, 25, 50, 100, 250, 500, 1000.	25

Example of a request:

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

Response

A successful response returns a JSON object with the list of notification handlers and associated metadata.

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"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://uptimekeep.com/api/notification-handler?&page=1",
        "last": "https://uptimekeep.com/api/notification-handler?&page=1",
        "next": null,
        "prev": null,
        "self": "https://uptimekeep.com/api/notification-handler?&page=1"
    }
}

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).

Meta Object

Field	Type	Description
page	Integer	Current page number of the results.
results_per_page	Integer	Number of results per page.
total	Integer	Total number of notification handlers.
total_pages	Integer	Total number of pages available based on the current query.

Links Object

Field	Type	Description
first	String	URL of the first page of results.
last	String	URL of the last page of results.
next	String	URL of the next page of results (if applicable).
prev	String	URL of the previous page of results (if applicable).
self	String	URL of the current page of results.

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code.