Skip to main content

/quickalerts/rest/v1/notifications REST Method

Creates a new QuickAlerts Notification.

Updated on
Oct 3, 2023

/quickalerts/rest/v1/notifications REST Method

Body Parameters

name
string
REQUIRED
A name for your notification. This is for your reference only.
expression
string<base64>
REQUIRED
Base64 encoded expression.
network
string
REQUIRED
The network for this notification. ENUM: "arbitrum-mainnet", "arbitrum-goerli", "arbitrum-sepolia", "avalanchec-mainnet", "avalanchec-fuji", "base-mainnet", "base-sepolia", "bnbchain-mainnet", "bnbchain-testnet", "bitcoin-mainnet", "celo-mainnet", "doge-mainnet", "ethereum-goerli", "ethereum-holesky", "ethereum-mainnet", "ethereum-sepolia", "fantom-mainnet", "gnosis-mainnet", "imx-testnet", "nova-mainnet", "optimism-mainnet", "optimism-goerli", "optimism-sepolia", "polygon-mainnet", "polygon-mumbai", "scroll-mainnet", "scroll-testnet", "tron-mainnet", "zkevm-mainnet", "zkevm-testnet", "zksync-mainnet", "zksync-testnet"
destinationIds
string[array]
REQUIRED
An array of strings containing the destination ids to which this notification will send payloads.

Returns

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 POST \
2
"https://api.quicknode.com/quickalerts/rest/v1/notifications" \
3
-H "accept: application/json" \
4
-H "Content-Type: application/json" \
5
-H "x-api-key: YOUR_API_KEY" \
6
-d $'{
7
"name": "My Notification",
8
"expression": "dHhfdG8gPT0gJzB4ZDhkQTZCRjI2OTY0YUY5RDdlRWQ5ZTAzRTUzNDE1RDM3YUE5NjA0NSc=",
9
"network": "ethereum-mainnet",
10
"destinationIds": [
11
"a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
12
]
13
}'
14
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free