Notify API
Webhooks for address activity, mined transactions, and dropped transactions, on Ethereum, Polygon, Optimism, and Arbitrum.
Want to learn more about how to use Alchemy Notify? Check out this guide on using Alchemy Notify and webhooks:

When to use the Notify API

We recommend using the Alchemy Notify API to automate the creation of webhooks, especially when dealing with Address Activity Webhooks for 10+ addresses, otherwise, you can easily create webhooks from within the dashboard!

Notify API Parameters

There are several parameters to understand when using the Notify API.

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 string enum:
  • "MINED_TRANSACTION"
  • "DROPPED_TRANSACTION"
  • "ADDRESS_ACTIVITY"

network

Each type of supported network is represented as a different string enum:
  • "ETH_MAINNET"
  • "ETH_GOERLI"
  • "ETH_ROPSTEN"
  • "ETH_RINKEBY"
  • "ETH_KOVAN"
  • "MATIC_MAINNET"
  • "MATIC_MUMBAI"
  • "ARB_MAINNET"
  • "ARB_RINKEBY"
  • "OPT_MAINNET"
  • "OPT_KOVAN"
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.

API Endpoints

The following endpoints are supported for all networks.

V1 vs. V2

All API Endpoints below are supported for both V1 and V2 versions of Alchemy Notify, however, the response payloads for both versions will differ, see the the difference between V1 and V2 question for more info.
NOTE: We highly recommend switching over to V2 webhooks, all net-new webhooks created after Wednesday, April 27th, 2022 will be V2.
get
https://dashboard.alchemyapi.io
/api/team-webhooks
Get all webhooks

Example Request

cURL
1
curl https://dashboard.alchemyapi.io/api/team-webhooks \
2
-X GET \
3
-H "X-Alchemy-Token":"your-X-Alchemy-Token"
Copied!
get
https://dashboard.alchemyapi.io
/api/webhook-addresses
Get all addresses for an Address Activity webhook

Example Request

cURL
1
curl --location --request GET 'https://dashboard.alchemyapi.io/api/webhook-addresses?webhook_id=148415' \
2
--header 'X-Alchemy-Token: your-X-Alchemy-Token'
Copied!
post
https://dashboard.alchemyapi.io
/api/create-webhook
Create webhook

Example Request

cURL
1
curl https://dashboard.alchemyapi.io/api/create-webhook \
2
-X POST \
3
-H "X-Alchemy-Token":"your-X-Alchemy-Token" \
4
-d '{"app_id":"your-app_id","webhook_type":"MINED_TRANSACTION","webhook_url":"https://webhook.site/7bf2c41e-846e-45a7-8c17-556dd7f5103c"}'
Copied!
patch
https://dashboard.alchemyapi.io
/api/update-webhook-addresses
Add & remove webhook addresses

Example Request

cURL
1
curl 'https://dashboard.alchemyapi.io/api/update-webhook-addresses' \
2
-X PATCH \
3
-H 'X-Alchemy-Token: your-X-Alchemy-Token' \
4
--data-raw '{"webhook_id":"wh_90yojhoxuer87l3t","addresses_to_add":["0xfdb16996831753d5331ff813c29a93c76834a0ad","0x48ea66f94518534ecbc863fbf521896d52b025d9", "0x6f8d0c2a2c3a189803f5c6482c88be46a55058c1"], "addresses_to_remove":[]}'
Copied!
put
https://dashboard.alchemyapi.io
/api/update-webhook-addresses
Replace webhook addresses

Example Request

cURL
1
curl https://dashboard.alchemyapi.io/api/update-webhook-addresses \
2
-X PUT \
3
-H "X-Alchemy-Token":"your-X-Alchemy-Token" \
4
-d '{"webhook_id":"104","addresses":["0x6f8d0c2a2c3a189803f5c6482c88be46a55058c1","0xfdb16996831753d5331ff813c29a93c76834a0ad"]}'
Copied!
put
https://dashboard.alchemyapi.io
/api/update-webhook
Update webhook status

Example Request

cURL
1
curl --location --request PUT 'https://dashboard.alchemyapi.io/api/update-webhook' \
2
--header 'X-Alchemy-Token: your-X-Alchemy-Token' \
3
--data-raw '{"webhook_id":"wh_tncylsr32dj4u9dm" ,"is_active":false}'
Copied!
delete
https://dashboard.alchemyapi.io
/api/delete-webhook
Delete webhook

Example Request

1
curl https://dashboard.alchemyapi.io/api/delete-webhook?webhook_id=104 \
2
-X DELETE \
3
-H "X-Alchemy-Token":"your-X-Alchemy-Token" \
Copied!

Types of Webhooks

There are three types of webhooks to receive notifications for:
  1. 1.
    Mined Transactions (all networks)
  2. 2.
    Dropped Transactions (all networks)
  3. 3.
    Address Activity (all networks)
To see in depth explanations for each of the Alchemy Notify webhooks check out the Using Webhooks guide.

Other Resources

If you want to learn more about how to leverage webhooks for your application, or have specific questions about Alchemy Notify, check out the Using Alchemy Notify doc and get information like:
For tutorials on integrating notifications into your dApp try out the following: