Skip to main content

Setting Up a Custom Validator Integration

Connect your content testing service to Knak. Validate asset content against your own business rules during the asset creation process.

Before You Begin

Before you connect your service to Knak, make sure it supports the required Custom Validator Application Programming Interface (API) endpoints.

You can find the complete API specification here:

Connect Your Custom Validator

  1. In Knak, navigate to Admin > Integrations > Platforms.

    Integrations > Platforms navigation in the admin side of Knak.

  2. Scroll to the Content Testing section.

  3. Click Connect on the Custom Validator tile.

    Connect button highlighted on the Custom Validator integration tile.

  4. Complete the required fields using your Custom Validator Credentials.

    Custom Validator settings configuration screen.

Configure Authentication

Enter the authentication details required by your validation service.

Field

Description

Auth Header Name

Enter the name of the HTTP authentication header your service expects.

Auth Header Value

Enter the authentication value that Knak should send with each request.

Select a Platform Format

Use the Platform Format field to choose which Marketing Automation Platform (MAP) the asset should be optimized for before validation.

Select the platform that matches your validation requirements. If your service does not require optimization for a specific platform, choose the appropriate generic option if available.

Enter the Endpoint URL

In the Endpoint URL field, enter the root URL for your Custom Validator API.

For example:

  • Validation endpoint:
    ​https://yourservice.com/yourapi/v1/validate

  • Endpoint URL to enter in Knak:
    ​yourservice.com/yourapi

Knak automatically appends the required API paths when sending validation requests.

Manage Your Integration

After setup, view your integration in the My Platform Connection list on the Integrations page.

From here, you can:

  • View the configuration

  • Edit the integration

  • Delete the integration

My Platform Connections section.

To connect a new integration or re-add a deleted one:

  1. Scroll to All Platforms.

  2. Find the Custom Validator tile.

  3. Click Connect or Add Another Connection.

Add Another Connection button highlighted on the Custom Validator Integration tile.

Use Your Custom Validator

After the integration is configured, users can run validation while editing an asset.

  1. Open an asset in the editor.

  2. Start the validation process.

  3. Click the Actions Menu.

  4. Select your Custom Validator.

The validator appears using the name you configured during setup.

When validation starts, Knak sends the latest version of the asset to your validation service. Your service returns the validation results based on your configured business rules.

Asset editor showing the Custom Validator in the validation menu.

How Validation Works

The validation request includes:

  • The latest version of the asset being edited.

  • The selected platform format, if configured.

  • The authentication headers you defined during setup.

Your validation service processes the request. It then returns the validation results to Knak.

Need more help? Contact support via live chat within Knak using the chat bubble in the bottom right corner or email support@knak.com.

Related Articles
Did this answer your question?