If you don’t see your preferred webhook provider, you can request support for it.
- Develop and test Coinbase webhooks locally without deploying to a public environment or setting up HTTPS.
- Inspect and troubleshoot requests from Coinbase in real time via the inspection UI and API.
- Modify and replay Coinbase webhook requests with a single click instead of reproducing events manually in your Coinbase account.
- Secure your app with Coinbase webhook validation provided by ngrok. Invalid requests are blocked by ngrok before reaching your app.
What you’ll need
- An ngrok account and your authtoken.
- The ngrok agent installed.
- Node.js installed (for the sample app, or use your own app).
- A Coinbase account.
1. Start your app
For this tutorial, you can use the sample Node.js app on GitHub. To install the sample, run the following in a terminal:http://localhost:3000.
The app logs request headers and body in the terminal and shows a message in the browser.
2. Expose your app with ngrok
Once your app is running locally, you’re ready to put it online securely using ngrok.- Copy your ngrok authtoken from the dashboard.
-
Start ngrok:
- Copy the URL ngrok displays. Your app is now exposed at that URL for use with Coinbase.
3. Configure Coinbase to send webhooks
Follow Coinbase’s documentation for setting up notifications, which delivers webhooks to a notification endpoint on your API key. Set the following:- Notification URL: your ngrok URL (for example,
https://1a2b-3c4d-5e6f-7g8h-9i0j.ngrok.app).
Run webhooks with Coinbase and ngrok
Coinbase sends a different request body for each event type. Perform an account activity such as buying an asset to trigger a notification. Confirm your app receives the event and logs its headers and body in the terminal.Inspecting requests
ngrok’s Traffic Inspector captures all requests made through your ngrok endpoint to your localhost app. Select any request to view detailed information about both the request and response.To avoid exposing secrets, accounts only collect traffic metadata by default.
You must enable full capture in the Traffic Inspector section of your account settings to capture complete request and response data.
- Validate webhook payloads and response data
- Debug request headers, methods, and status codes
- Troubleshoot integration issues without adding logging to your app
Replaying requests
Test your webhook handling code without triggering new events from your service using the Traffic Inspector’s replay feature:- Send a test webhook from your service to generate traffic in your Traffic Inspector.
- Select the request you want to replay in the traffic inspector.
-
Choose your replay option:
- Click Replay to send the exact same request again
- Select Replay with modifications to edit the request before sending
- (Optional) Modify the request: Edit any part of the original request, such as changing field values in the request body.
- Send the request by clicking Replay.
Secure webhook requests
ngrok can verify that incoming requests are from your Coinbase webhook so only that traffic reaches your app.Webhook verification is limited to 500 validations per month on free accounts.
If you need more, you can upgrade to Hobbyist or Pay-as-you-go.
See TPU Pricing for details.
-
Create a Traffic Policy file named
coinbase_policy.yml. Replace{your api secret}with the API Secret you copied when configuring the webhook: -
Restart ngrok with the policy file:
- Buy an asset in Coinbase to trigger the webhook.