Introducing webhooks: React to Web3 events in real-time

Whether you’re building NFTs, games, or other dApps, getting  on-chain event data to your team and community in real-time  can be difficult and consume valuable development resources. Imagine being able to set up Web3 event streams that deliver updates and data to your team and community as they happen, without having to manually check smart contracts, marketplaces, and other services. That’s what Dispatch webhooks delivers!

A sample Web3 webhook use case

What can you do with Dispatch webhooks?

Today, Dispatch beta users can create webhooks manually with our intuitive interface (web UI), using Web3 events as Triggers.

We currently support event monitoring on 4 networks:

• Ethereum
• Polygon
• BSC
• Avalanche
  

Triggers (aka topics) include:

• Balance changes
• Balance threshold crossings (going above or below a certain threshold)
• On-chain gameplay events (betting activity, inventory and client updates, etc.)
• NFT mints, transfers, forges and redemptions
• ERC-4337 account activity
• DEX activity
• Any other smart contract events

Check out Dispatch docs for more details on all the Triggers.

Notes

• We don't currently support webhook request authentication via headers, but it's on our roadmap.
• For security reasons, you should always verify that webhook requests originate from the api.dispatch.esprezzo.io domain; any other origin is not a legitimate Dispatch webhook request.

Getting started with Dispatch webhooks

To start getting real-time updates on NFT collection transfers, balance changes and more, you will need a free Dispatch account. The Dispatch beta is currently invite only. Don’t have an account yet? Join the waitlist!

Requirements

• A Dispatch account
• A webhook URL (where Dispatch will send event data). Your webhook URL can be
  • A public endpoint that your application can listen to for incoming web requests
  • A URL from a webhook testing site such as webhook.site
  • A URL from a secure tunneling service such as ngrok

In the steps below we’ll walk through creating a Patch (automation) that sends an HTTP request with a JSON payload to a URL at webhook.site whenever a Bored Ape Yacht Club NFT is transferred.

1: Pick a Trigger

Log in to Dispatch. From the Dashboard, select a Trigger from the dropdown.

The Trigger is the event you want to receive alerts for:

2: Select Webhook as the Action

You can either type “webhook” in the search box, or scroll through the alphabetical list of Actions (output channels) Dispatch supports:

 

3: Configure the Trigger

Here you’re refining the logic (adding filters) for your Trigger so you only receive notifications for the events you care about.

 

For NFT transfers, all you have to do is select the collection you’re interested in.

 

 

For balance changes and threshold crossings, you’ll choose the network, asset, and address(es) you want monitored.

For new DEX pairs and pools, you’ll choose the DEX you’re interested in, and you can enter a minimum liquidity amount as an optional filter.

4: Configure the Webhook

You’ll need the URL where you want Dispatch to send event data in this step.

Add a name for your webhook. If you’ll be using different webhooks for different events, you’ll want to pick a descriptive name so you can distinguish it from other webhooks when you create more Patches.

In the “Webhook URL” input, paste the webhook endpoint URL (the callback URL your app will use to accept the incoming webhook). In this example we’re using a URL we created with Webhook.site, a great and easy-to-use tool for testing and debugging webhook notifications.

 

5: Test the webhook

To make sure Dispatch can send to your URL, click the “Send a test JSON payload” button in step 5.

Here we can see the test payload at webhook.site:

 

6: Name your Patch, turn it on & wait for alerts!

Now all you have to do is give your Patch a name and turn it on.

And that’s it! Now just sit back and wait for your Web3 alerts to come in. Whenever a Bored Ape is transferred, Dispatch will send an HTTP POST to the URL you provided.

Tip 

Check out our Webhook Reference to see sample JSON payloads for each Trigger type.

What’s next

We designed Dispatch webhooks to help you and your community stay in sync while saving you time. If you use them, we’d love to hear what you think, and how we can make them more useful. Need a Dispatch invite?

 

 

We’re working on adding more Web3 data (event) sources.

• Want us to add a NFT collection? Submit a request
• General Trigger (event) requests go here

And if you’re interested in programmatic access to Dispatch, make sure you get on the list for early access to the API!

Don’t miss our updates: subscribe to our monthly newsletter, follow us on Twitter, or join us on Discord.