Skip to content

Postman collection

The collection calls https://webhookah.com. It creates an endpoint, sends a sample webhook, lists what arrived, then clears those requests and deletes the endpoint.

Using the API requires at least the Plus plan. Create a key under Dashboard → API Key before you import. The API guide explains the same calls.

  1. Open Postman and select your workspace.
  2. Click Use resources or import, then Import.
  3. Drop webhookah.postman_collection.json into the window, or paste this URL:
https://webhookah.com/docs/webhookah.postman_collection.json
  1. Wait for Import complete. Webhookah appears in the sidebar.

You can also drag the file onto the Postman window.

  1. Open the Webhookah collection.
  2. Open the Variables tab.
  3. Set apiKey to the key you copied from Dashboard → API Key. It starts with wh-. If Postman shows Initial value and Current value, put the key in Current value.
  4. Leave baseUrl as https://webhookah.com. For a local server, set it to http://localhost:1323.
  5. Save the collection.

endpointToken and endpointUrl stay empty until you run Create an endpoint. That request stores both for the later calls.

Requests in Receive a webhook, and Send a sample webhook, call the public /wh/{token} URL with no Authorization header.

Run the Try a webhook folder from top to bottom:

  1. Create an endpoint — POST /api/endpoints. Expect 201. The test script saves token and url.
  2. Send a sample webhook — POST to the saved URL with a JSON body. Expect 200 and {"message":"Webhook received successfully"}.
  3. List requests for this endpoint — GET /api/requests/endpoint/{{endpointToken}}. The sample send is in the array. body.json is the parsed object and body.raw is the original text.
  4. Clear requests for this endpoint — DELETE that same path. Expect 204. Do this while the endpoint still exists.
  5. Delete this endpoint — DELETE /api/endpoints/{{endpointToken}}. Expect 204. The URL stops accepting traffic.

A 403 with {"error":"URL limit reached for your plan"} means the account is at its endpoint limit.

In Postman, open the folder and use Run. Select only Try a webhook so the runner stays on this sequence.

  • Endpoints — list, create, set the badge, delete, and regenerate. Regenerate endpoints deletes every endpoint on the account and creates a new one.
  • Captured requests — list or clear every captured request, or only one endpoint. Clear all requests deletes every captured request on the account. Endpoints stay.
  • Live updates — GET /api/sse returns text/event-stream. Send Listen for requests on its own. Stored requests arrive first, then new requests, plus a heartbeat about every 30 seconds. Cancel the request when you are done watching.
  • Receive a webhook — POST, GET, PUT, PATCH, and DELETE to /wh/{{endpointToken}}. Header names that start with X- are dropped before storage.

Full request and response shapes are in the OpenAPI reference.