How To: Troubleshooting Webhooks

Welcome! This guide will walk you through how to inspect, debug and share the result of a request to a webhook receiver using Runscope in just a few short steps.

Create an Account

Sign Up — Free! or Sign In


Capture a Request

After creating your account and completing the tutorial you'll be taken to the Traffic Inspector. On the left-hand side locate your bucket key:

Bucket Key

Capture without Forwarding

If you only need to see the data being generated by the webhook provider, create a capture URL. Capture URLs log the data they receive without forwarding it and respond with a 200 OK.

The capture URL for a bucket is the bucket's key combined with For example:

Capture and Forward

If you'd like to capture the request and forward it to your public-facing web server, create a full Gateway URL. Using the bucket key from the previous step we're going to create a special URL that diverts your API call to go through Runscope on the way to the original API.

To convert a URL into a Gateway URL start with the hostname, change dots to dashes, add your bucket key and Runscope hostname and leave the scheme (http:// or https://), path and query parameters unchanged:




Register the Webhook URL

To start capturing requests to the capture or full URL you generated above you'll need to register the URL with the provider that will be generating the webhook notifications. This setting is typically configured through the provider's admin interface.

Inspecting Results

When the webhook is triggered (automatically based on an event or manually if your provider offers a test function) the executed request will show up in your Captures (for non-forwarding requests) or All Traffic stream. Clicking on the request will expand it to show you the full result of the call made.

Share the Result

Now that you've got a request in your stream you can create a shareable URL to send to others for review. To share a request with others, start by clicking the Link icon for any request in your stream:

That will bring you to the sharing preview screen. Click Create Share Link and copy the generated URL to your clipboard. Send the shareable URL to a friend, coworker or your API provider and they'll be able to view the request and response data to help you solve your problem.

Related: Troubleshooting HTTP and REST API Requests