Connectors · Reference

Open Connector SDK reference

Canonical modes and action families shared with policy, certification, and billing. Source: @nexus/types.

← Connectors hub

Connector modes

  • rest_api
  • graphql_api
  • webhook
  • polling_api
  • database
  • file_sftp
  • email_ingest
  • browser_automation
  • manual_human_step

Canonical action families

Adapters declare support; workflows target these names-not vendor endpoints.

  • read_record
  • list_records
  • create_record
  • update_record
  • upload_document
  • create_vendor
  • read_vendor
  • create_invoice
  • read_invoice
  • list_invoices
  • initiate_payment
  • initiate_payment_intent
  • mark_invoice_ready_for_payment
  • sync_invoice_status
  • approve_payment
  • post_journal
  • trigger_workflow
  • send_notification
  • reconcile_record

Diagnostics API (main app)

Authenticated technical bundle (adapter contract, certification reports, fixtures, redacted config preview):

GET /api/v1/connectors/instances/:id/diagnostics

Available for authorized workspace sessions and internal operator tooling.