Product Documentation
Relay: Getting Started
Our webhook relay allows you to take control and view insights for any webhooks your application consumes. Getting started is simple and the best part of all, our relay can be used with any services that provide webhooks.
To get started, we will walk you through the most basic setup for relaying your webhooks through our system.
Step 1: Understand the system.
Bucket: A bucket is
Input: A bucket is
Destination: A bucket is
Step 2: Create Input
Each new account has a "default" bucket created. For this example, the first input can be created in this default bucket. So navigate to the bucket and click the button titled "Add Input" - complete the form. This will provide you a URL that you can provide to the service provider you are receiving webhooks from.
Step 3: Create Destination
Once an input is created click the "Add Destination" button to configure where the webhooks should be passed to once they hit our system. Simple add the title of the endpoint and the destination URL, we will discuss some of the more advanced options in other sections.
Step 4: Update Webhook Provider Settings
At this point the input and destination have been setup within your webhooks.io account, so now we need to tell your service provider to start sending webhooks to your account. To do this you will just need to login to your service provider account and navigate to the webhooks settings area. With your webhooks.io input endpoint URL copied, paste the URL into the provider's endpoint field and save the settings.
At this point the service provider will be sending webhooks to your webhooks.io account which will then relay back out to the final destination(s).
That's it!
Now that your webhook requests are flowing through webhooks.io you can:
- View webhook insights including the ability to easily identify and resend failures
- Transform request security
- Pause certain destinations so you can perform server upgrades/maintenance.
If you have any problems we are here to help!
Buckets