Notify API

All the possible HTTP requests you can make when using the Notify API.

Want to learn more about Alchemy Notify? Check out this guide on webhooks. 
We recommend using this Notify API to automate the creation of webhooks and when dealing with Address Activity Webhooks for 10+ addresses, otherwise, you can easily create webhooks from the dashboard!
Note on API Parameters 
X-Alchemy-Token
Your Alchemy authentication token (X-Alchemy-Token) can be found in the upper right corner of your dashboard Notify page under the "AUTH TOKEN" button.
app_id
Your app_id can be found within the URL of your specific app. For example, given the URL https://dashboard.alchemyapi.io/apps/xfu8frt3wf94j7h5 your app_id would be xfu8frt3wf94j7h5
webhook_type
Each type of webhook is represented as a different integer:
Mined Transactions: 0
Dropped Transactions: 1
Address Activity: 4
Gas Price: 5
webhook_id
This is a unique identifier for the webhook. You can find the webhook_id by first getting all your webhooks using the endpoint below, then looking at the parameter "id" for the specific webhook you want. 
get
Get all webhooks
https://dashboard.alchemyapi.io/api/team-webhooks
This endpoint allows you to get all webhooks from every app on your team.
Request
Response
Request
Headers
X-Alchemy-Token
required
string
Alchemy Auth token to use the Notify API (see note above).
Response
200: OK
Sample Response:   
{
    "data": [
        {
            "id": 3,
            "app_id": "nd7cdkfe3cb4",
            "network": 0,
            "webhook_type": 1,
            "webhook_url": "http://www.YOUR-APP-URL.com",
            "is_active": true,
            "time_created": 1585779080000,
            "addresses": null
        },
        {
            "id": 17,
            "app_id": "pd63r8git3dlll0n",
            "network": 0,
            "webhook_type": 4,
            "webhook_url": "http://www.YOUR-APP-URL.com",
            "is_active": true,
            "time_created": 1596635655000,
            "addresses": [
                "0xfdb16996831753d5331ff813c29a93c76834a0ad",
                "0x6b175474e89094c44da98b954eedeac495271d0f",
                "0x48ea66f94518534ecbc863fbf521896d52b025d9",
                "0xdac17f958d2ee523a2206206994597c13d831ec7",
                "0x6f8d0c2a2c3a189803f5c6482c88be46a55058c1"
            ]
        }
    ]
}
Example Request
curl https://dashboard.alchemyapi.io/api/team-webhooks \
-X GET \
-H "X-Alchemy-Token":"your-X-Alchemy-Token"
post
Create webhook
https://dashboard.alchemyapi.io/api/create-webhook
This endpoint allows you to create a webhook.
Request
Response
Request
Headers
X-Alchemy-Token
required
string
Alchemy Auth token to use the Notify API (see note above for how to find it)
Body Parameters
app_id
required
string
App Id. See note above on where to find it.
webhook_type
required
integer
An Integer representing webhook type.
Dropped Transactions: 1
Mined Transactions: 2
Address Activity: 4
Gas Price: 5

webhook_url
required
string
URL where requests should be sent.
addresses
optional
array
List of addresses you want to track. For address activity webhooks only.
gas_price_low
optional
integer
If the gas price (in 10x gwei) is lower than this threshold, send a notification every minute. For gas price webhooks only.
gas_price_high
optional
integer
If the gas price (in 10x gwei) is higher than this threshold, send a notification every minute. For gas price webhooks only.
gas_price_type
optional
integer
Selects the metric to be used as the threshold price. 
SAFE_LOW = 0
AVERAGE = 1
FAST = 2
FASTEST = 3
For gas price webhooks only.
Response
200: OK
Sample response.
{
  "data": {
    "id": 103,
    "app_id": "nfu9f1t9fwf15r36",
    "network": 0,
    "webhook_type": 1,
    "webhook_url": "https://webhook.site/7bf2c41e-846e-45a7-8c17-556dd7f5103c",
    "is_active": true,
    "time_created": 1602618909000,
    "addresses": null,
    "gas_price_low": null,
    "gas_price_high": null,
    "gas_price_type": null
  }
}
Example Request 
Here is an example request for creating a dropped transaction webhook
curl https://dashboard.alchemyapi.io/api/create-webhook \
-X POST \
-H "X-Alchemy-Token":"your-X-Alchemy-Token" \
-d '{"app_id":"your-app_id","webhook_type":1,"webhook_url":"https://webhook.site/7bf2c41e-846e-45a7-8c17-556dd7f5103c"}'
patch
Add/remove webhook addresses 
https://dashboard.alchemyapi.io/api/update-webhook-addresses
Add or remove addresses from a specific webhook. 
Request
Response
Request
Headers
X-Alchemy-Token
required
string
Alchemy Auth token to use the Notify API
Body Parameters
webhook_id
required
number
Identifier for the webhook. See note above on how to find it.
addresses_to_add
required
array
List of addresses to add, use [] if none.
addresses_to_remove
required
array
List of addresses to remove, use [] if none.
Response
200: OK
{}
put
Update webhook addresses
https://dashboard.alchemyapi.io/api/update-webhook-addresses
Used to update webhook addresses, replacing any existing addresses. 
Request
Response
Request
Headers
X-Alchemy-Token
required
string
Alchemy Auth token to use the Notify API
Body Parameters
webhook_id
required
integer
Identifier for the webhook. See note above on how to find it.
addresses
required
array
New list of addresses to track. This replaces any existing addresses.
Response
200: OK
{}
Example Request 
curl https://dashboard.alchemyapi.io/api/update-webhook-addresses \
-X PUT \
-H "X-Alchemy-Token":"your-X-Alchemy-Token" \ 
-d '{"webhook_id":104,"addresses":["0x6f8d0c2a2c3a189803f5c6482c88be46a55058c1","0xfdb16996831753d5331ff813c29a93c76834a0ad"]}'
Example Request
curl https://dashboard.alchemyapi.io/api/update-webhook-addresses \
-X PATCH \
-H "X-Alchemy-Token":"your-X-Alchemy-Token" \ 
-d '{"webhook_id":27,"addresses_to_add":["0xfdb16996831753d5331ff813c29a93c76834a0ad","0x48ea66f94518534ecbc863fbf521896d52b025d9", "0x6f8d0c2a2c3a189803f5c6482c88be46a55058c1"], "addresses_to_remove":[]}'
put
Update webhook active status
https://dashboard.alchemyapi.io/api/update-webhook
Allows you to set active status of webhooks to active or inactive. 
Request
Response
Request
Headers
X-Alchemy-Token
required
string
Alchemy Auth token to use the Notify API
Body Parameters
webhook_id
required
integer
Identifier for the webhook. See note above on how to find it
is_active
required
boolean
True - set webhook to active state
False - set webhook to inactive state
Response
200: OK
{}
Example Request
curl https://dashboard.alchemyapi.io/api/update-webhook \
-X PUT \
-H "X-Alchemy-Token":"your-X-Alchemy-Token" \ 
-d '{"webhook_id":104,"is_active":False}'
delete
Delete webhook
https://dashboard.alchemyapi.io/api/delete-webhook
Delete a webhook.
Request
Response
Request
Headers
X-Alchemy-Token
required
string
Auth token for Notify API
Body Parameters
webhook_id
required
integer
Identifier for the webhook. See note above on how to find it.
Response
200: OK
{}
Example Request
curl https://dashboard.alchemyapi.io/api/delete-webhook \
-X DELETE \
-H "X-Alchemy-Token":"your-X-Alchemy-Token" \ 
-d '{"webhook_id":104}'

Block API (BETA)

Token API

Last updated 3 months ago

Notify API

`Note on API Parameters`

`X-Alchemy-Token`

`app_id`

`webhook_type`

`webhook_id`

get
Get all webhooks

Example Request

post
Create webhook

Example Request

patch
Add/remove webhook addresses

put
Update webhook addresses

Example Request

Example Request

put
Update webhook active status

Example Request

delete
Delete webhook

Example Request

Notify API

Note on API Parameters

X-Alchemy-Token

app_id

webhook_type

webhook_id

getGet all webhooks

Example Request

postCreate webhook

Example Request

patchAdd/remove webhook addresses

putUpdate webhook addresses

Example Request

Example Request

putUpdate webhook active status

Example Request

deleteDelete webhook

Example Request

`Note on API Parameters`

`X-Alchemy-Token`

`app_id`

`webhook_type`

`webhook_id`

get
Get all webhooks

post
Create webhook

patch
Add/remove webhook addresses

put
Update webhook addresses

put
Update webhook active status

delete
Delete webhook