Connector
Type: Object
Connectors are the engines that power the integration of external systems. They are responsible for handling the communication between the application and the external system. Connectors can be used to integrate with various external systems such as ERP systems, CRM systems, print workflow solutions, DFEs and more.
Fields
| Name | Type | Args | Description | Deprecated |
|---|---|---|---|---|
| actions | [ConnectorAction!] | Embedded actions that define the connector's functionality | ||
| apiEndpoints | [ConnectorApiEndpointTemplate!] | 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. | ||||
| children | [Connector!]! | filter: ConnectorFilterInputlimit: Intoffset: Intsort: [ConnectorSortInput] | Any connectors derived from this connector | |
| config | JsonString | A JSON-Schema of config that this Connector requires in order to be able | ||
| to function. | ||||
| connectorType | String! | The type/category of connector (e.g., :preflight, :dfe, :general) | ||
| createdAt | DateTime! | |||
| description | String | A description of how the connector works and what it does | ||
| handle | String! | A url-safe short handle to refer to this connector | ||
| iamPolicy | JsonString | An IAM policy that defines the permissions for this Connector. Installing the Connector will grant the Connection these permissions. | ||
| id | ID! | |||
| libraryId | ID | If this connector comes from the library, then this will be set. | ||
| Library connectors must be cloned to be edited. | ||||
| name | String! | The human readable name of the connector | ||
| parent | Connector | The Connector this is derived from, if relevant | ||
| parentId | ID | |||
| published | Boolean | If published, this version of the connector is finalized and cannot be further edited. | ||
| reactions | [ConnectorReactionTemplate!] | 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. | ||||
| sharedLibrary | String | A 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 | [ConnectorTimerTemplate!] | 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. | ||||
| updatedAt | DateTime! | |||
| version | Int! | The revision of the connector - multiple versions can be deployed at once of a single connector |