Skip to main content

/quickalerts/rest/v1/notifications REST Method

Retrieve a list of notifications.

Updated on
Oct 3, 2023

/quickalerts/rest/v1/notifications REST Method

Query Parameters

limit
number
The maximum number of destinations to return. Default: 20
offset
number
The offset to start from. Default: 0

Returns

data
object
A group of notifications represented as arrays, with each array containing the following values:
id
string
The notification ID.
created_at
string
The date and time the notification was created.
updated_at
string
The date and time the notification was last updated.
name
string
The name of the notification.
expression
string
The expression for the notification.
network
string
The network for the notification.
destinations
object
The destinations for the notification returned as arrays.
id
string
The ID of the destination.
name
string
The name of the destination.
to
string
The webhook URL to which QuickAlerts will send alert payloads.
webhook_type
string
The type of destination. ENUM: "POST", "GET"
service
string
The destination service.
payload_type
number
The type of payload to send. ENUM: 1,2,3,4,5,6,7
enabled
boolean
Whether the notification is enabled.
Request
1
curl -X GET \
2
    "https://api.quicknode.com/quickalerts/rest/v1/notifications" \
3
    -H "accept: application/json" \
4
    -H "x-api-key: YOUR_API_KEY"
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free