In this section · 4 articles

Test a webhook destination

Send one payload to a destination straight away with the Test Console, and see the exact headers that were sent, the response code, the response and how long it took.

Applies to
Webhook Engine 2.2 and later
Who can do this
Platform owner, Administrator, Developer
Permission
feature.webhook.destination.test
Where
Webhook Engine › Destinations
On this page

Use the Test Console after you add a destination, after the receiver changes, or when deliveries fail and you want to see the receiver's answer for yourself.

Before you start

  • You need Send Test Payload (feature.webhook.destination.test) and List Destination (feature.webhook.destination.list).
  • A test is a real request to the receiving system, signed with the destination's real secret. Tell the receiver's owner if a test message could trigger something on their side.

Steps

  1. In the sidebar, open Webhook Engine › Destinations.

  2. In the destination's row, select Test Console.

    The Test Console opens. Beside the destination's status, it shows how the test is signed: Signs timestamp + payload (v2) or Signs payload only (v1), following the destination's Sign the timestamp setting.

    Test Console for the Order system destination, with its status and the Signs timestamp + payload (v2) badge highlighted, the sample test.ping JSON in Payload, and the Format and Send test buttons.
  3. In Payload, keep the sample or paste your own JSON. The sample is a test.ping event with a random ping_id and your name in authorized_by.

  4. Optional: select Format to tidy the JSON. If it isn't valid JSON, you see This is not valid JSON, so it cannot be sent.

  5. Select Send test.

The result appears in three tiles and three tabs:

PartWhat it shows
OutcomeDelivered when the receiver answered at all, Failed when it couldn't be reached or didn't answer within 10 seconds.
HTTP statusThe receiver's response code, such as 200 or 401.
Round tripHow long the request took.
Response bodyWhat the receiver sent back.
Request headersEvery header that was sent, including the signature headers and your custom headers. The signing secret itself is never shown.
Response headersThe headers the receiver sent back.

Careful: Outcome shows Delivered even when the receiver answers with an error, such as 401 or 500. Always read HTTP status: only a 2xx code would count as success for a real delivery.

What a test does and doesn't do

  • It's sent at once, even if the destination is Inactive or Suspended, and even if its rate limit would delay a real delivery.
  • It isn't written to the delivery log and doesn't change Consecutive Failures.
  • It's sent once. A failed test isn't retried.
  • Its User-Agent header is Laramin-WebhookEngine-Test/2.2.0, so the receiver can tell tests apart. Real deliveries say Laramin-WebhookEngine/2.2.0.
  • The payload doesn't have to look like a real event. To check how the receiver handles a real one, paste a payload copied from a delivery in Webhook Engine › Delivery Logs.

Reading the result

You seeLikely cause
HTTP status 200 to 299The receiver accepted it.
401 or 403The receiver rejected the signature or a missing header. Check the receiver has the right secret and checks the right version. See Verify webhook signatures and handle retries.
404 or 405The Endpoint URL is wrong, or the receiver doesn't accept POST.
500 or higherThe receiver had an error. Its owner should check their logs.
Failed with no statusThe address couldn't be reached or took longer than 10 seconds. Check the address, and that the receiving server is up and reachable from your Laramin's server.

For more causes, see Deliveries fail or a destination is suspended.