Skip to content

Plugin SDK ​

When Corveil doesn't ship a first-party source for a system, you can build your own with the Plugin SDK. A source implements a small Go interface — the source runtime owns persistence and org-scoping, so your plugin just returns normalized events.

At a glance, a source implements:

  • Configure(config) — apply configuration.
  • Validate(ctx) — check the data source is reachable (powers Test connection).
  • Poll(ctx, cursor) — fetch new events since a cursor, return events + the next cursor.
  • Backfill(ctx, since, until) — fetch a historical range (optional).
  • Health(ctx) — report current status.

Each source also declares the config and credential fields the Add sensor form renders — the same fields the sensor guides document. Credential fields can reference a credential vault type by id instead of taking an inline secret.