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

post

Bodyobject · FieldToValidate[][]

application/json

fieldNamestringOptional

valuestringOptional

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /validate HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: */*
Content-Length: 39

[
  [
    {
      "fieldName": "text",
      "value": "text"
    }
  ]
]

200

OK

[
  [
    true
  ]
]