Validation Webhook

OneSchema’s validation API allows you to use your own API endpoint to create a column validator.

Validation Webhook

Similar to our data export webhooks feature, you will only need a URL endpoint and a template to get started using this feature. Once your validation webhook is configured, every time your template is applied to a new list, your validation webhook will be run alongside our other validations in our validation library.

OneSchema's validation API operates by sending POST requests with JSON values to the supplied endpoints.

For row hooks, each request will have a customizable batch size which defaults to 1000 values. If a list has more rows than the batch size, multiple requests for a row hook will be sent. You can also select the specific columns you want sent in each row hook request by specifying the associated template column keys. Row hooks are triggered on initial validation as well as after subsequent updates to the sheet.

For column hooks, only one request will be sent with ALL of the rows on the spreadsheet even if the spreadsheet has more than 1000 rows. Column hooks are triggered once on initial validation and once before the importer webhook is triggered, but not on every sheet update.

The request schema will look like this:

Copy of Validation JSON request schema

ParameterTypeDescription
rows*Object[]Array of rows to validate.
rows[].row_id*IntegerId of a single row. Use this value in the response data to specify errors.
rows[].values*ObjectA map from template column names to the value in that column for a single row. All values are represented as strings. Only columns that are part of the hook's configuration are included.
template_key*StringAn optional key specified on the template that can be used instead of template_id to determine what template is being validated.
hook_id*IntegerA unique identifier for this validation hook.
hook_name*StringThe name of the hook, as configured on the validation hook UI.
workspace_id*IntegerThe id of Workspace containing the Sheet containing the rows being validated.
sheet_id*IntegerThe id of the Sheet containing the rows being validated.
sheet_metadata*ObjectA JSON Object containing any custom metadata associated with the Sheet at time of import. Includes two additional fields added automatically by OneSchema: original_file_name containing the name of the original uploaded file, and original_sheet_name containing the name of the sheet in the imported Excel file, if part of a multi-sheet Excel file upload.
embed_user_jwt*StringIf you are embedding OneSchema within your own site, this will contain the JWT token used to initialize a customer’s session.

Example JSON POST

{
  "rows": [
    {
      "row_id": 1,
      "values": {
        "contact_id": "1438263",
        "contact_name": "John Doe",
        "business_vertical": "SaaS Sales"
      }
    },
    {
      "row_id": 2,
      "values": {
        "contact_id": "900372",
        "contact_name": "Aaron Smith",
        "business_vertical": "Sportswear"
      }
    },
    {
      "row_id": 3,
      "values": {
        "contact_id": "6803830",
        "contact_name": "Johnny Apple",
        "business_vertical": "Shipping Infrastructure"
      }
    },
    {
      "row_id": 4,
      "values": {
        "contact_id": "1684023",
        "contact_name": "Nancy Jackson",
        "business_vertical": "Marketing"
      }
    }
  ],
  "template_key": "contact-template",
  "hook_id": 823,
  "hook_name": "Hook 1",
  "workspace_id": 23155,
  "sheet_id": 23145,
  "sheet_metadata": {
    "original_file_name": "contacts.csv"
  },
  "embed_user_jwt": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiI2N2JiMmU1Zi1mMGY3LTQyYTYtYTUxMS0xOGIyNWU2N2I4YzQiLCJ1c2VyX2asdasdasdasd.MaxfODdhWqVamNgK7l8mZrR-A4B2uGDuPWLOreu7dQI"
}

In order to validate the values, OneSchema will expect the endpoint to return an array of warnings and errors. Each warning and error should specify the row_id, the column the warning or error appeared in, the severity of the issue ("warning" or "error"), a message to be displayed in the UI, and optionally a suggestion can be provided to the user.

Issues can be raised for multiple columns in a single row. For example, if a validation hook verifies that two columns A and B sum to a value in column C, the validation hook may choose to say only column C has an error, or that each of columns A, B, and C have an error, depending on the relationship between the columns and the semantics they want to expose.

Validation Hook JSON Response Schema

ParameterTypeDescription
[]Object[]The response should be an array of validations.
[].row_idIntegerThe row_id with the warning or error.
[].columnStringThe key of the template column where the validation should be displayed.
[].severityStringEither "warning" (displayed in yellow) or "error" (displayed in red).
[].messageStringMessage to be displayed to user when they click on the validation.
[].suggestionString(Optional) A suggestion for a new value that will be displayed to the user. The user may choose whether or not to accept the suggested value.
[].optionsObject(Optional) Additional information related to the error. Keys may include:

popover_title: The title of the popover which appears when the user clicks an error or warning in OneSchema.

Example JSON Response

[
  {
    "row_id": 2,
    "column": "employee_name",
    "severity": "warning",
    "message": "Employee no longer works for company."
  },
  {
    "row_id": 2,
    "column": "employee_end_date",
    "severity": "error",
    "message": "Employee gave notice on this date.",
    "suggestion": "04/15/2020"
  },
  {
    "row_id": 3,
    "column": "employee_name",
    "severity": "error",
    "message": "Employee's name has changed",
    "suggestion": "Johnny Appleseed"
  }
]

Securing your validation hook

To secure your validation hook, we can optionally authenticate requests using HTTP Basic Auth. If a secret token is supplied, it will be used as the basic auth password in the request to the provided endpoint. No username is passed through.

Embedding

When using webhooks with embedded OneSchema, the JWT token that was used to initialize the session will also be sent in the top-level key embed_user_jwt.