Version: v1.13 print this page

Connections Apps (Beta API Only)

Connections Apps enables the user to ingest data from SaaS applications into Amorphic Datasets and can be used for further ETL/Analytics. As a Beta release, Amorphic supports this feature as API only type. Amorphic uses AWS AppFlow in the backend to transfer the data. Appflow supports AWS managed connectors as well as custom connectors created by the user. For ingesting data using Connections Apps, there are 3 steps:

Choose an inbuilt connector/Create your own Custom Connector.
Create a Connection App using this selected connector.
Define a flow on this Connection App and run the flow.

With this release, Amorphic supports Slack, Zendesk, Salesforce, Google Analytics and ServiceNow amongst the AWS managed connectors and adds support for Custom Connectors. In the first section, we will describe all functions related to custom connectors. If you are using an AWS managed connector, skip to Connections Apps.

Custom Connector

Custom Connector allows ingestion of data from any 3rd party Saas application. This is enabled by the AppFlow Custom Connector SDK. For this purpose, the connector developer will need to implement 3 main interfaces from the SDK. These are:

Interface	Description
Configuration Handler	Defines all functionality related to authentication and configuration.
Metadata Handler	Retrieves metadata and parses it into Appflow specific format.
Record Handler	Defines all functionality related to record related CRUD operations.

The connector developers therefore are essentially writing the wiring code to translate from vendor’s API to the generic AppFlow custom connector interface. The custom connector implementation code along with the SDK and any 3rd party dependencies needs to be bundled into a zip file. This zip file can be used to register a custom connector in Amorphic.

Below are the list of API's and their corresponding methods to be used to create, update and delete Custom Connectors in Amorphic:

API's List

/connections/apps/connectors
- GET -- Returns details about all custom & inbuilt connectors.
- POST -- Saves custom connector metadata & returns a signed URL for file upload.
/connections/apps/connectors/{connectorId}
- GET -- Returns details about a single custom connector.
- POST -- Start the asynchronous process for custom connector creation/updation.
- PUT -- Updates custom connector metadata & returns a signed URL for file upload.
- DELETE -- Delete a custom connector.

Note

Please replace {connectorId} with the ConnectorId which is received from the backend response.

API Request Payload Details

To retrieve details about all custom/inbuilt connectors as well as to download the Custom Connector template

/connections/apps/connectors & GET method

Response depends on query parameters(if any).

Query parameter	Response
None	Returns details about all inbuilt connectors.
connector_type = custom	Returns details about all custom connectors.
download_template = yes	Returns a download link for a Custom Connector sample template.

To create a custom connector
This is a multi step process - save metadata, upload zip file and then run the asynchronous process for registering a custom connector.
/connections/apps/connectors & POST method
Request payload for saving custom connector metadata
```
    {
        "ConnectorName": <String>, (must be unique across an AWS account)
        "Description": <String>,
        "LambdaHandler": <String>,
        "Keywords": <String>
    }
```
- LambdaHandler: The fully qualified name of the lambda handler used in the Custom Connector code.For example, in the provided Sample Connector Template, it will be: custom_connector_example.handlers.lambda_handler.app_lambda_handler
Note
The response will contain a signed URL for uploading the custom connector zip file. Make a PUT request using this link. Please make the next API request only after this file is uploaded.
/connections/apps/connectors/{ConnectorId} & POST method
Request payload for registering custom connector
```
    {
        "ConnectorAction" : "create-connector"
    }
```
To update a custom connector
Similar to create, this is also a multi step process - update metadata, upload zip file and then run the asynchronous process for registering a custom connector.
/connections/apps/connectors/{connectorId} & PUT method
Request payload for saving custom connector metadata
```
    {
        "Description": <String>,
        "LambdaHandler": <String>,
        "Keywords": <String>
    }
```
- LambdaHandler: The fully qualified name of the lambda handler used in the Custom Connector code.For example, in the provided Sample Connector Template, it will be: custom_connector_example.handlers.lambda_handler.app_lambda_handler
Note
The response will contain a signed URL for uploading the custom connector zip file. Make a PUT request using this link. Please make the next API request only after this file is uploaded.
/connections/apps/connectors/{connetorId} & POST method
Request payload for registering custom connector
```
    {
        "ConnectorAction" : "update-connector"
    }
```
Note
If the update fails for any reason, then the connector will automatically rollback to the previous implementation.