How to Integrate Alchemy Address Activity Webhooks with Zapier
Learn how to integrate Alchemy’s address activity webhook into Zapier to get email notifications for external transfers when you send and receive ETH via Metamask on the Goerli testnet.
Overview
- What are Alchemy webhooks?
- What are the two different applications webhooks connect?
- Which Alchemy webhook does this tutorial use?
- Required Tools
- 9 steps to integrate Alchemy webhooks into Zapier
What are Alchemy Webhooks?
Alchemy Webhooks enable Web3 developers to receive notifications when predetermined events are triggered on Alchemy-supported blockchains.
Webhooks are efficient and friendly tools for Web3 developers in comparison to continuously polling nodes to check if a particular state has changed
Alchemy webhooks have a lot of potential to improve the user experience and drive the engagement of Web3 applications and services, such as tracking NFT sales in a discord channel or sending wallet activity to a slack channel
What are the two different applications that webhooks connect?
The two applications that webhooks connect are sender and receiver applications.
The “sender” application subscribes to events and sends data to the webhook URL of the “receiver” application. The receiver application then takes actions based on the received data.
The data, or the webhook response, is a JSON object that contains information inside it. Without using Zapier, the response will just be a response, and users won't actually see anything or be notified. With Zapier, Alchemy webhook responses can integrate with applications (e.g. Gmail) to perform an action (e.g. sending email).
Connecting webhook responses to a service like Zapier can help complete the communication loop and create a more useful product for developers and users.
Which Alchemy webhook does this tutorial use?
In this tutorial, we will be setting up Alchemy’s address activity webhook (one of the four types of Alchemy Webhooks), which tracks all ETH and token transfer events for an Ethereum address.
We will then integrate it into Zapier for us to receive real-time email updates whenever our Ethereum address successfully sends or receives tokens.
We will use the virtual crypto wallet Metamask to initiate the transfer events between two accounts, and we will operate on the Goerli testnet to avoid spending real ETH.
You can also choose another testnet for this tutorial, but we recommend using Goerli as all other testnets on Ethereum are expected to be deprecated after the Merge.
Required Tools
There aren’t many developer tools required for this tutorial. You just have to have the accounts for the different platforms we will be using:
- An Alchemy account (and Notify API from Alchemy’s Enhanced API Product, but not required)
- Two Ethereum addresses (Metamask recommended)
- A Zapier account
9 steps to integrate Alchemy webhooks into Zapier
To integrate Alchemy with Zapier so that users can receive email notifications for sending and receiving ETH, use these seven steps:
- Set up Metamask
- Add ETH from Alchemy’s Goerli faucet
- Create a Zap and a webhook URL
- Create an Alchemy webhook
- Parse webhook response in Zapier
- Send an email with Zapier's Gmail action
- Test sending ETH with Metamask
- Write some code to handle receiving ETH as well!
- Test receiving ETH with Metamask
Let’s get started!
1. Set up Metamask
Download and install Metamask as an extension in your browser for free.
Then, in your wallet, create two accounts to simulate sending and receiving transactions.
For the sake of clarity, “our” Ethereum address will be Account 1, meaning that we will only track the transfer events for Account 1.
Account 1 will be linked to our email, and we will receive email updates whenever Account 1 sends ETH to or receives ETH from Account 2.
Make sure to switch over to the “Goerli Test Network” in the “Networks” dropdown on top so we are dealing with fake ETH.
NOTE:
If the dropdown doesn’t initially display test networks, click on your profile picture on the upper right corner and go to “Settings > Advanced” and scroll down to turn on “Show test networks.”
2. Add ETH from Alchemy’s Goerli faucet
Next, we will need some fake ETH to make transactions. To get your ETH, go to Alchemy’s Goerli faucet, which provides you with free tokens on the Goerli testnet for development purposes.
Make sure to create a free Alchemy account so that you can get 5X as much Goerli ETH!
Enter the public address of Account 1 and click “Send Me ETH.”
You should see 0.05 ETH (or 0.01 ETH if you are not logged in) added to the account soon after.
3. Create a Zap and a webhook URL
First, create your Zapier account or log into your account if you already have a Zapier account.
Next, in the dashboard, click “Create Zap” in the top left corner.
We will first handle sending emails to users whenever they successfully send some ETH to another account, but notifying users when they received ETH will be similar (and covered below).
We will now create the webhook URL for sending the webhook response from Alchemy to Zapier.
Under “Trigger,” search and select “Webhooks by Zapier” as the app event/trigger.
For the “Trigger Event,” select “Catch Hook” since Zapier is waiting for Alchemy’s address activity webhook to send the event data to the URL whenever a transfer occurs.
Click “Continue” to the “Set up trigger” section and copy the “Custom Webhook URL.”
4. Create an Alchemy Webhook
Now, we need to create the address activity webhook to track transfer events and send that data off to the Zapier webhook URL. If you don’t have one, create a free Alchemy account.
We will show two ways that you can set up the webhook, first from Alchemy’s Notify tab within the dashboard, and second programmatically by using Notify API Endpoints (recommended for dealing with address activity webhooks for 10+ addresses).
Create a Webhook from the Dashboard
Make sure you are in the “Ethereum + L2” ecosystem on the upper left of the Alchemy dashboard.
Navigate to the Notify tab and click “+ Create Webhook” button in the “Address Activity” section.
Next, fill in these fields to create the webhook:
- Select “Chain” to be “Ethereum,”
- Select “Network” to be “Goerli,”
Then, paste in the webhook URL you copied from Zapier in the last step as well as your Account 1 address in Metamask.
NOTE:
If you want to test if the Alchemy webhook successfully sends requests to Zapier’s webhook URL before confirming the creation, click on “Test Webhook” next to the webhook URL. Or if you have already created the webhook but want to test again, click on the three dots by your webhook and select “Send Test Notification.”
Go back to Zapier and continue to the “Test trigger” section, and click “Test trigger.”
If you see a “We found a request” message, congratulations - the setup is complete.
Create a webhook using Notify API
Creating a webhook using the Notify API Endpointsis recommended if your webhook is tracking the transfer events for 10 or more Ethereum addresses.
To get started, copy your Alchemy authentication token (X-Alchemy-Token
) from the upper right corner of your Notify dashboard under the “AUTH TOKEN” button.
Then, navigate to your command line and type:
curl https://dashboard.alchemyapi.io/api/create-webhook \
-X POST \
-H "X-Alchemy-Token":"your-X-Alchemy-Token" \
-d '{"network":"ETH_GOERLI","webhook_type":"ADDRESS_ACTIVITY","webhook_url":"your-Zapier-Webhook-URL", "addresses":["your-Ethereum-Address"]}'
Remember to use your own your-X-Alchemy-Token
, your-Zapier-Webhook-URL
and your-Ethereum-Address
(aka, Account 1), and you can add as many Ethereum addresses as you’d like to track their transfer events.
After refreshing, you should see the newly created address activity webhook appear in your Notify dashboard with all your specified parameters.
For more API calls to do things like adding, removing, or updating webhook addresses, please see the Notify API Endpoints.
5. Parse webhook response in Zapier
Given the webhook response from Alchemy, we need to parse it in Zapier to create an action that sends us an email whenever our address successfully sends a transaction.
First, let’s take a look at an example response:
{
"webhookId": "wh_octjglnywaupz6th",
"id": "whevt_ogrc5v64myey69ux",
"createdAt": "2022-02-28T17:48:53.306Z",
"type": "ADDRESS_ACTIVITY",
"event": {
"network": "MATIC_MAINNET",
"activity": [
{
"category": "token",
"fromAddress": "0x59479de9d374bdbcba6c791e5d036591976fe422",
"toAddress": "0x59479de9d374bdbcba6c791e5d036591976fe425",
"erc721TokenId": "0x1",
"rawContract": {
"rawValue": "0x",
"address": "0x93C46aA4DdfD0413d95D0eF3c478982997cE9861"
},
"log": {
"removed": false,
"address": "0x93C46aA4DdfD0413d95D0eF3c478982997cE9861",
"data": "0x",
"topics": [
"0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
"0x00000000000000000000000059479de9d374bdbcba6c791e5d036591976fe422",
"0x00000000000000000000000059479de9d374bdbcba6c791e5d036591976fe425",
"0x0000000000000000000000000000000000000000000000000000000000000001"
]
}
}
]
}
}
Without getting into the weeds, this will be a useful reference when we use the value of each field to construct our email. We will only use a few for this tutorial, but feel free to check out Notify API Quickstart for address activity on what each field represents in more detail!
Because we are handling sending ETH first, we need to check if the fromAddress
(the account initiating the transfer) in each response matches the address of Account 1.
To do so:
- Under the “Action” section, select the “Filter” option on the right-hand side
- In “Filter setup & testing,” we want to continue if the “Event Activity From Address” (or you can simply search for “
fromAddress
”) “(Text) Exactly matches” our Account 1 Ethereum address (paste it into the last text field).
If you click “Continue” and find that “Your Zap would not have continued,” don’t worry! The test notification was not sent from our Account 1 in Metamask so this message is expected.
6. Send Email with Zapier's Gmail Action
Next, we want to send the email to the recipient if the sender of the transfer event is Account 1.
- Click “+” at the bottom, then search for and select “Gmail” in the new “Action” section.
- For the “Action Event,” choose “Send Email.”
- After clicking “Continue,” this will prompt you to sign in to your Gmail account.
Lastly, we will need to fill out the fields to send our email in the “Set up action” section.
For the “To” field, you can enter your own email address.
For the “Subject” (required), you can put something like “Transfer Sent!”
Where we are really going to take advantage of the webhook response is in the “Body,” where we can parse the fields to display the details of the transfer in the email.
By searching for the fields in “Insert Data…” dropdown, I used these values of these fields to construct my email, but feel free to customize it to your liking:
After clicking “Continue” and testing the action, you should soon after receive an email containing your specified message!
NOTE:
The webhook response alone does not provide you with the email address of the owner of the
fromAddress
. So, if you are managing many users with different emails and want to automate this process, you may want to ask your users for both their Ethereum address and email address when they sign up for this service.
You can then store them in a database like Google Firestore (or an IPFS-based distributed database for decentralization, but Zapier doesn’t currently seem to support this).
Then, using the “Firebase / Firestore” app in Zapier, you can run a query to find the email address associated with the fromAddress
in the webhook response and use that as your “To” field in the Gmail app action.
7. Test sending ETH with Metamask
Now, let’s turn on our Zap and see this project in action.
- First, go to Account 1 in Metamask and click the “Send” button in the middle.
- For “Send to,” choose “Transfer between my accounts” and select Account 2 as the recipient.
- After specifying an amount and confirming the gas fee, click on “Confirm”!
Again, make sure you are on the “Goerli Test Network” while doing this (since our Alchemy webhook tracks transfers on the Goerli testnet).
After a while, you should see an email in your inbox that looks something like this:
You can also view the run details of your Zap on the “Zap History” page in the Zapier dashboard.
Double-check your two accounts in Metamask to see if the transfer has successfully been sent and received, and see if the accounts in the email body match the sender (Account 1) and receiver (Account 2).
8. Write code to handle receiving ETH
We are not quite done yet with this project, as we still need to send emails whenever Account 1 receives some ETH from another account.
To do so, we will add on to our current Zap but specifically for the toAddress
field.
This actually requires some coding since based on whether Account 1 sends or receives ETH, the subject and body of the email will have to change accordingly.
So, let’s create a “Code by Zapier” action between our “Only continue if…” and “Send Email in Gmail” actions.
You can choose either “Run Python” or “Run Javascript,” we will choose the latter but the logic works the same for Python.
After clicking “Continue,” we will set up our input data under “Set up action” as follows:
We are parsing through the webhook response again because our current email subject and body are only written for when Account 1 sends ETH. Therefore, we need to customize them for when Account 1 receives ETH.
In the code block, paste in the following code (read the comments to see what each line means):
// Since JavaScript is case-sensitive, we will be comparing addresses in upper case
const address = "your-Account-1-Address".toUpperCase();
// Define Account 1 (the user we are sending email to)
let account_1 = "";
// Define Account 2 (the user Account 1 is sending to/receiving from)
let account_2 = "";
// Define if to use "sent" or "received" in email subject/body
let s_or_r = "";
// Define if to use "to" or "from" in email body
let t_or_f = "";
if (inputData.fromAddress.toUpperCase() == address) {
// If Account 1 is sending, then it is the fromAddress
account_1 = inputData.fromAddress;
account_2 = inputData.toAddress;
s_or_r = "sent";
t_or_f = "to";
} else if (inputData.toAddress.toUpperCase() == address) {
// If Account 1 is receiving, then it is the toAddress
account_1 = inputData.toAddress;
account_2 = inputData.fromAddress;
s_or_r = "received";
t_or_f = "from";
}
// Output the fields to be used in email
output = [{account_1: account_1, account_2: account_2, s_or_r: s_or_r, t_or_f: t_or_f}];
Again, remember to replace your-Account-1-Address
with the public address of your Account 1 in Metamask. And when testing the action, don’t worry if it doesn’t assign anything to the output variables - this is because we are not using our real Metamask account yet.
Lastly, go to the “Send Email in Gmail” action and click on the “Set up action” section.
We will now replace the generic fields from the webhook response in the email subject and body with the more dynamic outputs from our Javascript code, which are customized depending on whether Account 1 sent or received ETH:
Click “Continue” and test your action.
One thing to look out for is that since editing a Zap will automatically turn it off, make sure you turn it back on before our final testing step.
NOTE:
In Metamask, you can technically send some ETH from an account to itself, which we did not account for in our JavaScript code since it is redundant for the sake of this project. But you can definitely try to add it into the code’s logic yourself!
9. Test receiving ETH with Metamask
We will now test if we get an email when Account 1 receives ETH from another account.
Since we have sent a little bit of ETH from Account 1 to Account 2 in our “Test sending ETH with Metamask” step, you should have some amount of ETH in Account 2.
If not, simply send some from Account 1 or use the Goerli faucet for Account 2.
Next, similar to how we sent ETH before, send some ETH from Account 2 to Account 1 and wait for the transaction to go through.
You should receive an email soon after that looks something like this:
Again, check if the grammar is correct in the email subject and body and if the accounts match the sender and receiver.
Once you have done so, you now have a fully functioning connection between the Alchemy webhook and Zapier that sends email notifications to you whenever a transfer on Goerli is detected for your Metamask account!
Final Remarks
Congrats! You have just successfully integrated Alchemy’s webhook into Zapier, exciting stuff!
We can’t wait to see the amazing projects you are going to build with Alchemy webhooks!
And if you do, don’t forget to share it with us on Twitter or reach out on Discord for any questions (or just to say hi)!
Happy hacking! 🎉
Updated almost 2 years ago