Qodex.ai

Ping Webhook

POST {{endpoint}}/webhooks/ping

Use this route to send a test request to your webhook

Required properties

  • url url string
  • httpMethod string, should be a valid HTTP method, default to "POST"

Optional properties:

  • body body of the request, can be anything
  • headers object containing custom headers that are added to the request headers

Returns

  • 200 if the request was sent successfully to the webhook, use data field in the response body to access the webhook's response body
  • 401 if authentication fails

Request Body

{"url"=>"YOUR_WEBHOOK_URL", "httpMethod"=>"HTTP_METHOD"}

RESPONSES

status: OK

{"status":200,"statusText":"OK","headers":{"server":"nginx","content-type":"text/plain; charset=UTF-8","transfer-encoding":"chunked","connection":"close","vary":"Accept-Encoding","x-request-id":"5cb73c19-ce0d-4b35-ba02-317e56c43d67","x-token-id":"3d224d6e-b525-45dd-9a60-5581df9264b9","cache-control":"no-cache, private","date":"Wed, 24 Aug 2022 19:34:31 GMT"},"data":""}