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 using Alchemy Notify and 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
https://dashboard.alchemyapi.io
/api/team-webhooks
Get all webhooks

Example Request

1
curl https://dashboard.alchemyapi.io/api/team-webhooks \
2
-X GET \
3
-H "X-Alchemy-Token":"your-X-Alchemy-Token"
Copied!
post
https://dashboard.alchemyapi.io
/api/create-webhook
Create webhook

Example Request

Here is an example request for creating a dropped transaction webhook
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":1,"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
1
curl https://dashboard.alchemyapi.io/api/update-webhook-addresses \
2
-X PATCH \
3
-H "X-Alchemy-Token":"your-X-Alchemy-Token" \
4
-d '{"webhook_id":27,"addresses_to_add":["0xfdb16996831753d5331ff813c29a93c76834a0ad","0x48ea66f94518534ecbc863fbf521896d52b025d9", "0x6f8d0c2a2c3a189803f5c6482c88be46a55058c1"], "addresses_to_remove":[]}'
Copied!
put
https://dashboard.alchemyapi.io
/api/update-webhook
put
https://dashboard.alchemyapi.io
/api/update-webhook-addresses
Update webhook addresses

Example Request

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

Example Request

1
curl https://dashboard.alchemyapi.io/api/update-webhook \
2
-X PUT \
3
-H "X-Alchemy-Token":"your-X-Alchemy-Token" \
4
-d '{"webhook_id":104,"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

To see in depth explanations for each of the Alchemy Notify webhooks check out the Using Webhooks guide.

Mined Transaction

The Mined Transaction Webhook is used to notify your app anytime a transaction sent through your API key gets successfully mined. This is extremely useful if you want to notify customers the moment their transactions goes through.

Example Response

1
{
2
"app": "Demo",
3
"network": "MAINNET",
4
"webhookType": "MINED_TRANSACTION",
5
"fullTransaction": {
6
"hash": "0x5a4bf6970980a9381e6d6c78d96ab278035bbff58c383ffe96a0a2bbc7c02a4b",
7
"blockHash": "0xaa20f7bde5be60603f11a45fc4923aab7552be775403fc00c2e6b805e6297dbe",
8
"blockNumber": "0x989680",
9
"from": "0x8a9d69aa686fa0f9bbdec21294f67d4d9cfb4a3e",
10
"gas": "0x5208",
11
"gasPrice": "0x165a0bc00",
12
"input": "0x",
13
"nonce": "0x2f",
14
"r": "0x575d26288c1e3aa63e80eea927f54d5ad587ad795ad830149837258344a87d7c",
15
"s": "0x25f5a3abf22f5b8ef6ed307a76e670f0c9fb4a71fab2621fce8b52da2ab8fe82",
16
"to": "0xd69b8ff1888e78d9c337c2f2e6b3bf3e7357800e",
17
"transactionIndex": "0x66",
18
"v": "0x1c",
19
"value": "0x1bc16d674ec80000"
20
},
21
"timestamp": "2020-07-29T00:29:18.414Z"
22
}
Copied!

Dropped Transactions

The Dropped Transactions Webhook is used to notify your app anytime a transaction send through your API key gets dropped.

Example Response

1
{
2
"app": "Alchemy Mainnet",
3
"network": "MAINNET",
4
"webhookType": "DROPPED_TRANSACTION",
5
"timestamp": "2020-06-08T22:12:57.126Z",
6
"fullTransaction": {
7
"hash": "0x5a4bf6970980a9381e6d6c78d96ab278035bbff58c383ffe96a0a2bbc7c02a4b",
8
"blockHash": null,
9
"blockNumber": null,
10
"from": "0x8a9d69aa686fa0f9bbdec21294f67d4d9cfb4a3e",
11
"gas": "0x5208",
12
"gasPrice": "0x165a0bc00",
13
"input": "0x",
14
"nonce": "0x2f",
15
"r": "0x575d26288c1e3aa63e80eea927f54d5ad587ad795ad830149837258344a87d7c",
16
"s": "0x25f5a3abf22f5b8ef6ed307a76e670f0c9fb4a71fab2621fce8b52da2ab8fe82",
17
"to": "0xd69b8ff1888e78d9c337c2f2e6b3bf3e7357800e",
18
"transactionIndex": null,
19
"v": "0x1c",
20
"value": "0x1bc16d674ec80000"
21
}
22
}
Copied!

Address Activity

The Address Activity Webhook allows you to track all ETH, ERC20 and ERC721 transfer events for as many Ethereum addresses as you'd like. This provides your app with real-time state changes when an address sends or receives tokens. For more details on this API specification check out the page below.
If you are looking for historical activity, check out the Transfers API!
Example Response
1
{
2
"app": "Test webhooks",
3
"network": "MAINNET",
4
"webhookType": "ADDRESS_ACTIVITY",
5
"timestamp": null,
6
"activity": [
7
{
8
"blockNum": "0xcec92a",
9
"hash": "0xbcbbd7c7de7b835939fb14d4ebe4d31ea6167f4c27c6f0940bb3fa1a90867abe",
10
"fromAddress": "0x86005b57be708e031ea60acf9d3852377e74a6c9",
11
"toAddress": "0x7a250d5630b4cf539739df2c5dacb4c659f2488d",
12
"value": 0.1,
13
"erc721TokenId": null,
14
"erc1155Metadata": null,
15
"asset": "WETH",
16
"category": "token",
17
"rawContract": {
18
"rawValue": "0x000000000000000000000000000000000000000000000000016345785d8a0000",
19
"address": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
20
"decimals": 18
21
},
22
"typeTraceAddress": null,
23
"log": {
24
"address": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
25
"topics": [
26
"0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
27
"0x00000000000000000000000086005b57be708e031ea60acf9d3852377e74a6c9",
28
"0x0000000000000000000000007a250d5630b4cf539739df2c5dacb4c659f2488d"
29
],
30
"data": "0x000000000000000000000000000000000000000000000000016345785d8a0000",
31
"blockNumber": "0xcec92a",
32
"transactionHash": "0xbcbbd7c7de7b835939fb14d4ebe4d31ea6167f4c27c6f0940bb3fa1a90867abe",
33
"transactionIndex": "0x4",
34
"blockHash": "0xb75dbed0d0c362fad4171c0e6bebb6e14288b871c02b82a3fc97ca8e05ed2fe2",
35
"logIndex": "0x11",
36
"removed": false
37
}
38
},
39
{
40
"fromAddress": "0xca92a49187edce00ba235634b4ca13e89abb33fe",
41
"toAddress": "0x9f5c880690e8a9dc7ce1142e304515eeb8b55e8f",
42
"blockNum": "0x97c8c1",
43
"category": "token",
44
"hash": "0x5f07f0a4ebb894ac2e4d5f0e03b50bfa7e1933f3c7641795500c806f77d9e592",
45
"value": null,
46
"erc721TokenId": "0x1",
47
"asset": "API",
48
"rawContract": {
49
"rawValue": "0x",
50
"address": "0x4c4a07f737bf57f6632b6cab089b78f62385acae",
51
"decimals": null
52
}
53
"typeTraceAddress": null
54
"log": null
55
},
56
{
57
"blockNum": "0xbe09fa",
58
"hash": "0x1635135c035cd81320e444f4dd88296f408ee7305c3e07f7863e3142d017ec45",
59
"fromAddress": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
60
"toAddress": "0xe592427a0aece92de3edee1f18e0157c05861564",
61
"value": 0.33974794305157613,
62
"asset": "ETH",
63
"category": "internal",
64
"erc721TokenId": null,
65
"typeTraceAddress": "call_1_1_0",
66
"rawContract": {
67
"rawValue": "0x4b706f442c2433c",
68
"address": null,
69
"decimals": 18
70
}
71
"log": null
72
},
73
{
74
"fromAddress": "0x38f22e75642b91568ba9bdbf94c9c843b38f2721",
75
"toAddress": "0x7a250d5630b4cf539739df2c5dacb4c659f2488d",
76
"blockNum": "0xbe09fb",
77
"hash": "0x9ff35291bcc0a1b359c1360c8a9f7eef0d7c48a1db5d0520aedebf2c8a8e3eb6",
78
"category": "external",
79
"value": 0.2,
80
"erc721TokenId": null,
81
"asset": "ETH",
82
"rawContract": {
83
"rawValue": "0x2c68af0bb140000",
84
"address": null,
85
"decimals": 18
86
},
87
"typeTraceAddress": null
88
"log": null
89
},
90
]
91
}
Copied!

Gas Price

The Gas Price Webhook allows you to receive a notification every minute when the Mainnet gas price rises above or drops below a certain threshold that you can select. It works by pulling the current gas prices from ETH Gas Station every minute.
Gas prices typically fall in a range, where a lower gas price means that the transaction will take longer to be mined, and a higher gas price means that the transaction will be mined more quickly. The Execution Speed metric allows you to specify a metric in that range that you would like to receive notifications, corresponding to ETH Gas Station's Price Type metric documented here. For example, selecting an Average Execution Speed means that you will receive notifications when a gas price typically mined in under 5 minutes rises above or drops below your selected threshold
Example Response
1
{
2
"app": "Alchemy Mainnet",
3
"network": "MAINNET",
4
"timestamp": "2020-09-09T15:14:19.175Z",
5
"gasPriceMetadata": {
6
"fast": 160,
7
"fastest": 167,
8
"safeLow": 147,
9
"average": 150,
10
"block_time": 11.894736842105264,
11
"blockNum": 10828228,
12
"speed": 0.9968284026882861,
13
"safeLowWait": 14.6,
14
"avgWait": 3.9,
15
"fastWait": 0.4,
16
"fastestWait": 0.4
17
}
18
}
Copied!
For instructions on how to set up webhooks from the dashboard check out the page below:
Last modified 22d ago