Connectors

Show API code examples on this page as

A connector allows Triggerware to interact with an external source of data. Think of Triggerware as one massive virtual database, and think of each connector as tables within that database.

The Connector Catalog

There are many pre-written connectors available for you to install. You can browse them in the console or list them through the API:

GET /connectors/catalog

curl https://api.triggerware.com/connectors/catalog \
  -H "Api-Key: YOUR_API_KEY"

To see the full schema of a specific connector — its tables, columns, types, and descriptions:

GET /connectors/catalog/{name}

curl https://api.triggerware.com/connectors/catalog/<name> \
  -H "Api-Key: YOUR_API_KEY"

Installing Connectors

Your instance starts with no connectors installed. To use a connector in your queries, install it first:

PUT /connectors/installed/{name}

curl -X PUT https://api.triggerware.com/connectors/installed/<name> \
  -H "Api-Key: YOUR_API_KEY"

Some connectors require configuration before they’ll work — for example, an API key for a third-party service. You can check whether a connector needs configuration by looking at the config_schema field in its schema. If it does, set the config after installing:

POST /connectors/installed/{name}/config

curl -X POST https://api.triggerware.com/connectors/installed/<name>/config \
  -H "Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{...}'

Managing Installed Connectors

List all connectors currently installed on your instance:

GET /connectors/installed

curl https://api.triggerware.com/connectors/installed \
  -H "Api-Key: YOUR_API_KEY"

Get details on a single installed connector:

GET /connectors/installed/{name}

curl https://api.triggerware.com/connectors/installed/<name> \
  -H "Api-Key: YOUR_API_KEY"

Once a connector is installed and configured, you can run a test against it. Triggerware generates and executes a sample query using Claude so you can verify the connector is working:

POST /connectors/installed/{name}/run

curl -X POST https://api.triggerware.com/connectors/installed/<name>/run \
  -H "Api-Key: YOUR_API_KEY"

Uninstall a connector you no longer need:

DELETE /connectors/installed/{name}

curl -X DELETE https://api.triggerware.com/connectors/installed/<name> \
  -H "Api-Key: YOUR_API_KEY"

Custom Connectors

If the catalog doesn’t have what you need, you can create your own. Custom connectors are Python scripts paired with a YAML schema that describes their tables and columns. Describe the data source you want in plain English and Triggerware generates everything:

POST /connectors/custom

curl -X POST https://api.triggerware.com/connectors/custom \
  -H "Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{...}'

List your custom connectors:

GET /connectors/custom

curl https://api.triggerware.com/connectors/custom \
  -H "Api-Key: YOUR_API_KEY"

Fetch the schema of a single custom connector:

GET /connectors/custom/{name}

curl https://api.triggerware.com/connectors/custom/<name> \
  -H "Api-Key: YOUR_API_KEY"

You can inspect and edit both the Python source and the YAML schema at any time:

GET /connectors/custom/{name}/python

curl https://api.triggerware.com/connectors/custom/<name>/python \
  -H "Api-Key: YOUR_API_KEY"

GET /connectors/custom/{name}/yaml

curl https://api.triggerware.com/connectors/custom/<name>/yaml \
  -H "Api-Key: YOUR_API_KEY"

Update the Python code:

PUT /connectors/custom/{name}/python

curl -X PUT https://api.triggerware.com/connectors/custom/<name>/python \
  -H "Api-Key: YOUR_API_KEY" \
  -H "Content-Type: text/plain" \
  -d "..."

Update the YAML schema:

PUT /connectors/custom/{name}/yaml

curl -X PUT https://api.triggerware.com/connectors/custom/<name>/yaml \
  -H "Api-Key: YOUR_API_KEY" \
  -H "Content-Type: text/plain" \
  -d "..."

If a custom connector starts erroring, Triggerware can read its error log and patch the Python source for you using Claude. Returns a short summary of what changed:

POST /connectors/custom/{name}/fix

curl -X POST https://api.triggerware.com/connectors/custom/<name>/fix \
  -H "Api-Key: YOUR_API_KEY"

Delete a custom connector:

DELETE /connectors/custom/{name}

curl -X DELETE https://api.triggerware.com/connectors/custom/<name> \
  -H "Api-Key: YOUR_API_KEY"

Testing a Custom Connector

Before a custom connector can be queried, it needs to be installed on your instance — just like a catalog connector. The typical workflow is:

Create the custom connector (from a prompt or by uploading code + schema).
Review the generated schema and code in the console or via the API.
Install it on your instance using the install endpoint.
Run a test query to verify the data looks right.
Once installed, it’s queryable alongside all your other connectors.