Skip to content

Connector operators

Public

The Connector family contains 4 operators. Outbound calls to third-party services (auth-gated by secret refs).

Executes an action on a connected external service.

Version 1.0.0 · Semantics side_effect · Visibility advanced

FieldTypeRequiredDefaultDescription
actionstringyes
connector_idstringyes
paramsobjectno
PortTypeRequiredDescription
inputanynoInput
PortTypeRequiredDescription
outputanynoOutput

Calls a third-party API through a tenant-scoped connector credential (OAuth2, API key, basic, bearer).

Version 1.0.0 · Semantics side_effect

FieldTypeRequiredDefaultDescription
connector_idstringyesID of the connector credential to use (looked up in glyph.connector_credentials).
requestobjectyesHTTP request to send. Either ‘url’ or ‘path’ (joined to credential.base_url) is required.
PortTypeRequiredDescription
inputanynoInput
PortTypeRequiredDescription
outputobjectnoOutput

Lists resources of a given kind from a connector (e.g. customers, charges). Dispatched by connector_kind to per-kind handlers.

Version 1.0.0 · Semantics side_effect · Idempotent

FieldTypeRequiredDefaultDescription
connector_idstringyesID of the connector credential to use.
pageintegerno1
resource_kindstringyesKind of resource to list (e.g. ‘customers’, ‘accounts’).
PortTypeRequiredDescription
inputanynoInput
PortTypeRequiredDescription
outputobjectnoOutput

Searches a connected external service.

Version 1.0.0 · Semantics side_effect · Visibility advanced

FieldTypeRequiredDefaultDescription
connector_idstringyes
query_templatestringno
PortTypeRequiredDescription
querystringyesQuery
PortTypeRequiredDescription
resultsarraynoResults

Every operator above is rendered from its JSON schema in /opt/glyph/schemas/operators/:

  • schemas/operators/connector.action.json
  • schemas/operators/connector.invoke.json
  • schemas/operators/connector.list_resources.json
  • schemas/operators/connector.search.json