CreateConnectorInput
Type: Input
Fields
| Name | Type | Default | Description |
|---|---|---|---|
| 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. | |||
| 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) | |
| 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. | |
| name | String! | The human readable name of the connector | |
| parentId | ID | ||
| published | Boolean | If 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. | |||
| 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 | [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. | |||
| version | Int! | The revision of the connector - multiple versions can be deployed at once of a single connector |