Documentation

Custom Credential Builder

The Custom Credential Builder empowers developers and workspace admins to securely map and manage dynamic Custom API authentication modes directly within the nLink Platform—without writing a single line of backend Go code.

Key Features

Working in tandem with the Dynamic API Builder, the Credential Builder guarantees that custom Community Integrations can authenticate themselves via flexible models while strictly adhering to nLink's enterprise-grade encryption standards.

  • 1. UI-Driven Security Modeling
    Instantly craft your required authentication properties using an intuitive interface. Add text variables, password inputs, boolean toggles, or OAuth flows contextually. The system automatically generates underlying JSON structures that transparently separate public UI definitions from sensitive encrypted secrets.
  • 2. Fast JSON Payload Import
    Easily migrate, back up, or share credential schemas across teams at the structural level using the built-in raw JSON payload import/export workflow. You can paste raw schema definitions directly into the Builder Mode to seamlessly pre-populate configurations.
  • 3. Auto Prefix Injection & Isolation
    For maximum security and operational stability, the nLink platform actively prevents rogue schema overrides or unintentional conflicts. All custom schemas are strictly isolated using the non-negotiable nlink-credential.custom- internal prefix during the hot-reload validation process.

Under the Hood

When you map and publish a Custom Credential via the UI, the backend engine acts synchronously to embed it into the orchestration context:

1. Struct Validation: The schema passes through strict internal data validations.
2. File Generation: A raw JSON structural artifact (e.g., your_api.json) is materialized inside the credentials directory.
3. Zero-Downtime Reloading: The schema repository natively forces a Node hot-reload over the active application memory.
4. Canvas Availability: The Credential configuration instantly appears within the Workflow Canvas for integration binding.

Example: Custom Discord Webhook

You can directly paste the following payload into the JSON Mode of the Credential Builder to automatically provision a secure Discord Webhook credential structure:

{
  "name": "Discord Webhook",
  "code": "nlink-credential.custom-discord_webhook",
  "description": "Send alerts and messages directly to Discord channels",
  "icon": "bi-discord",
  "type": "webhook",
  "group": "community",
  "fields": [
    {
      "key": "webhook_url",
      "type": "text",
      "label": "Webhook URL",
      "placeholder": "https://discord.com/api/webhooks/...",
      "required": true,
      "encrypted": true,
      "description": "Your private Webhook URL from Discord Server Integration Settings"
    }
  ]
}