Integration

Integration type — exchange data with external systems and services. Use it to send or receive data through webhooks, APIs, SFTP, and AS2, as well as process integration-specific callbacks.

webhook-sender

Sends data to a configured webhook endpoint.

{
  "type": "webhook-sender",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"Callback\",\"type\":\"object\",\"properties\":{\"retries\":{\"default\":3,\"description\":\"Number of retries\",\"maximum\":10,\"type\":\"integer\",\"minimum\":0},\"inputFilename\":{\"description\":\"Input filename\",\"type\":\"string\"},\"url\":{\"format\":\"uri\",\"description\":\"URL of receiver\",\"type\":\"string\"},\"timeout\":{\"default\":5000,\"description\":\"Timeout in ms\",\"maximum\":60000,\"type\":\"integer\",\"minimum\":100},\"successCode\":{\"default\":200,\"description\":\"Success code\",\"type\":\"integer\"}},\"required\":[\"url\"]}",
  "multipleInput": false,
  "outputParam": []
}

sftp-uploader

Uploads a file through SFTP.

{
  "type": "sftp-uploader",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"SFTP Uploader\",\"type\":\"object\",\"properties\":{\"path\":{\"description\":\"Path with a filename (expression can be used)\",\"type\":\"string\"},\"inputFilename\":{\"description\":\"Input filename\",\"type\":\"string\"}},\"required\":[\"path\"]}",
  "multipleInput": false,
  "outputParam": []
}

api-caller

Sends a GET or POST request to an external API.

{
  "type": "api-caller",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"API caller\",\"type\":\"object\",\"properties\":{\"retries\":{\"default\":3,\"description\":\"Number of retries\",\"maximum\":10,\"type\":\"integer\",\"minimum\":0},\"filename\":{\"description\":\"File name for output file\",\"type\":\"string\"},\"method\":{\"description\":\"POST or GET method\",\"type\":\"string\",\"enum\":[\"post\",\"get\"]},\"contentType\":{\"description\":\"Content-Type header\",\"type\":\"string\"},\"url\":{\"format\":\"uri\",\"description\":\"URL of receiver\",\"type\":\"string\"},\"timeout\":{\"default\":5000,\"description\":\"Timeout in ms\",\"maximum\":60000,\"type\":\"integer\",\"minimum\":100},\"successCode\":{\"default\":200,\"description\":\"Success code\",\"type\":\"integer\"}},\"required\":[\"url\",\"method\"]}",
  "multipleInput": false,
  "outputParam": []
}

sftp-receiver

Receives files through SFTP and filters them using a configured matching pattern.

{
  "type": "sftp-receiver",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"SFTP Receiver\",\"type\":\"object\",\"properties\":{\"pattern\":{\"default\":\"(.*)\",\"description\":\"File matching pattern\",\"type\":\"string\"},\"patternSource\":{\"default\":\"name\",\"description\":\"File matching pattern source: name, content or attribute\",\"type\":\"string\"}},\"required\":[\"pattern\",\"patternSource\"]}",
  "multipleInput": false,
  "outputParam": []
}

vchasno-callback-checker

Checks a Vchasno callback using the configured document type and configuration ID.

{
  "type": "vchasno-callback-checker",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"Vchasno callback checker\",\"type\":\"object\",\"properties\":{\"documentType\":{\"description\":\"Connector document type\",\"type\":\"string\"},\"configurationId\":{\"format\":\"uuid\",\"description\":\"ID of the configuration\",\"type\":\"string\"}}}",
  "multipleInput": false,
  "outputParam": []
}

as2-sender

Sends data to an external system through AS2.

{
  "type": "as2-sender",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"AS2 Sender\",\"type\":\"object\",\"properties\":{\"algorithmCrypt\":{\"description\":\"Encryption algorithm\",\"type\":\"string\",\"enum\":[\"3des\",\"cast5\",\"idea\",\"rc2\",\"aes128-cbc\",\"aes192-cbc\",\"aes256-cbc\",\"aes128-gcm\",\"aes192-gcm\",\"aes256-gcm\"]},\"senderId\":{\"description\":\"ID of sender\",\"type\":\"string\"},\"receiverCertificate\":{\"description\":\"Certificate of receiver (Base64 or URL)\",\"type\":\"string\"},\"inputFilename\":{\"description\":\"Input filename\",\"type\":\"string\"},\"receiverId\":{\"description\":\"ID of receiver\",\"type\":\"string\"},\"filename\":{\"description\":\"File name (expression can be used)\",\"type\":\"string\"},\"algorithmSign\":{\"description\":\"Signing algorithm\",\"type\":\"string\",\"enum\":[\"md5\",\"sha-1\",\"sha-256\",\"sha-512\",\"sha2_256\",\"sha2_512\",\"rsassa-pss-sha-256\",\"rsassa-pss-sha-512\",\"rsassa-pss-sha3-256\",\"rsassa-pss-sha3-512\"]},\"senderEmail\":{\"format\":\"email\",\"description\":\"e-mail of sender\",\"type\":\"string\"},\"messageId\":{\"description\":\"Message ID (expression can be used)\",\"type\":\"string\"},\"receiverUrl\":{\"format\":\"uri\",\"description\":\"URL of receiver\",\"type\":\"string\"}},\"required\":[\"senderId\",\"senderEmail\",\"receiverId\",\"receiverUrl\",\"receiverCertificate\"]}",
  "multipleInput": false,
  "outputParam": []
}

as2-receiver

Receives data through AS2.

{
  "type": "as2-receiver",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"AS2 Receiver\",\"type\":\"object\",\"properties\":{}}",
  "multipleInput": false,
  "outputParam": [
    "receiver"
  ]
}

webhook-receiver

Receives data through a webhook.

{
  "type": "webhook-receiver",
  "configSchema": "{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"title\":\"Web Hook\",\"type\":\"object\",\"properties\":{}}",
  "multipleInput": false,
  "outputParam": []
}