Skip to content

CreateConnectorInput

Type: Input

Fields

NameTypeDefaultDescription
actions[ConnectorActionsInput!]Embedded actions that define the connector's functionality
apiEndpoints[ConnectorApiEndpointsInput!]ApiEndpoints enable a Connector to receive inbound HTTP requests from a remote service - for example
orders from a Shopify store, or JMF messages from a print DFE.
configJsonStringA JSON-Schema of config that this Connector requires in order to be able
to function.
connectorTypeStringThe type/category of connector (e.g., :preflight, :dfe, :general)
descriptionStringA description of how the connector works and what it does
handleString!A url-safe short handle to refer to this connector
iamPolicyJsonStringAn IAM policy that defines the permissions for this Connector. Installing the Connector will grant the Connection these permissions.
nameString!The human readable name of the connector
parentIdID
publishedBooleanIf published, this version of the connector is finalized and cannot be further edited.
reactions[ConnectorReactionsInput!]Reactions enable a Connector to subscribe to data change events within the system.
This enables event-driven processing, such as sending a job specification to an external service
when the job is state changes.
sharedLibraryStringA connector can include a shared lua script that is used by all of the modules.
This script can provide things like data mappers, or other custom utilities to avoid duplication.
timers[ConnectorTimersInput!]Timers enable a Connector to periodically check for updated data in another data
source. This could be querying a database, reading a file or making an HTTP request.
versionInt!The revision of the connector - multiple versions can be deployed at once of a single connector

Connect. Combine. Collaborate.
The pioneering open integration platform, dedicated to transforming connectivity in the printing industry.