OpenAPI Validation Webhook Testing

Testing your validation webhook in the browser

This OpenAPI file, validation_webhook.yaml, describes the API that must be implemented by your validation endpoint. This definition can be used in Postman or a similar API tool to create a server. Below we have body and response examples & schemas for review.

2KB

validation_webhook.yaml

Validate

POSThttp://localhost:3000/validate

Body

application/json

fieldNamestring

valuestring

Response

200

OK

Body

application/json

itemsFieldValidationOutput (one of)

booleanobjectobjectobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('http://localhost:3000/validate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      [
        {}
      ]
    ]),
});
const data = await response.json();

Response

200

[
  [
    false
  ]
]