PHphilterd
Webhook

Send a test event to the webhook.

Changed on

Sends one signed WEBHOOK_TEST event to the webhook now, signed and checked against the destination allowlist as a real delivery is, and returns what happened: whether the receiver answered 2xx, its status code, and any error. The event is not queued or retried and does not appear in GET /api/webhook/deliveries. Its body has "test": true so a receiver can ignore it. Waits for the receiver up to WEBHOOK_CONNECT_TIMEOUT_SECONDS and WEBHOOK_RESPONSE_TIMEOUT_SECONDS. Admins may test another user's webhook via the owner parameter. Recorded as a webhook_tested audit event with the outcome; the URL and secret are not recorded. Requires the webhooks:write scope.

post/api/webhook/test

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/webhook/test
  • Auth
    HTTP bearer

Query parameters

ownerstring

Headers

Authorizationstring required

Response

The test was attempted. delivered says whether the receiver accepted it.

deliveredboolean

Whether the receiver answered with a 2xx status.

deliveryIdstring

The test event's X-Philter-Delivery-Id, to find it in the receiver's logs.

durationMillisinteger

How long the attempt took, in milliseconds.

errorstring

Why the test was not delivered, or null when it was.

statusCodeinteger

The status the receiver answered with, or null when there was no answer, such as when the connection failed, timed out, or the destination is not permitted.

Changes

  • c4f85daa9208Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • b0989dc2f6bfRevision changes
    • info

      endpoint added