CreateIntegrationRequest

Payload to register or update an external integration

namestringrequired

Example: acme-sftp

integrationTypeIntegrationType (string)required

Type of external system

Possible values: [SFTP, FTP, FTPS, S3, AZURE_BLOB, GCS, REST_API, DATABASE, LOCAL_FS]

Example: SFTP

credentialIdstring

ID of the credential to use for authentication

Example: cred-001

config object

Connector-specific configuration (host, port, bucket, region, etc.)

property name*any

Connector-specific configuration (host, port, bucket, region, etc.)

Example: {"host":"sftp.acme.com","port":22,"remotePath":"/outbound/payments/"}

CreateIntegrationRequest

{
  "name": "acme-sftp",
  "integrationType": "SFTP",
  "credentialId": "cred-001",
  "config": {
    "host": "sftp.acme.com",
    "port": 22,
    "remotePath": "/outbound/payments/"
  }
}