Webhook.site API¶
The Webhook.site API is public, free and easy to use. If you have a Webhook.site Account, you should authorize via an Api-Key.
General Usage¶
Base URL: https://webhook.site
.
You must set the Accept
and Content-Type
headers to application/json
.
You must set the Api-Key
header if you have a Webhook.site account.
Common Uses¶
Things to Note¶
- In this API documentation, URL parameters are prefixed with
:
(colon) to show which parameters must be changed by the user. You must not include this character in the URL. - A Token ID refers to the ID of the Webhook.site URL/e-mail address, i.e., when your Webhook.site URL is
https://webhook.site/00000000-0000-0000-0000-000000000000
, the Token ID is then00000000-0000-0000-0000-000000000000
. - In API URLs, you cannot use Token Aliases in place of the Token ID.
- Webhook.site API Keys must be specified using the
Api-Key
HTTP header. - Fair use guidelines, rate limits, and other limitations apply as described by the Terms of Service.
API Key¶
While many endpoints of the Webhook.site API are public and work without any authentication, some endpoints do require authentication, or will return a 401 Unauthorized
status code. Resources that are associated with a Webhook.site account always require an API Key.
API Keys have the same privileges as the user who created them.
API Keys must be specified in the Api-Key
HTTP header.
Common Usages¶
Get data sent to URL¶
To retrieve the data that's sent to a Webhook.site URL or Email, you'll want to use the Get Requests endpoint.
Create new URL/email address¶
To create a new token programmatically, you can use the API like this:
This will return information about the token in JSON format, including its UUID. Your URL will be available at the endpoint https://webhook.site/[token uuid]
.
If you are a Webhook.site Pro or Enterprise customer, you should provide an API key in order to associate the created token with your account automatically: