Skip to content

Send documents securely (TeamBeam)

The service task “Send documents securely (TeamBeam)” delivers sensitive files via the TeamBeam platform. Files are encrypted during delivery and recipients receive a protected download link.

Input parameters

Provide the following fields as input for the task:

{
  "host": "pro.teambeam.de",
  "accessHost": "sension.teambeam.pro",
  "adminUnit": "sension",
  "credentials": {
    "email": "laborbefund@sension.eu",
    "password": "********"
  },
  "fileReferences": [
    "s3://secure-bucket/reports/labor-report.pdf"
  ],
  "receivers": [
    {
      "email": "peter.velten@pantarey.io",
      "name": "Peter Velten",
      "type": "to"
    }
  ],
  "subject": "Secure lab report delivery",
  "description": "Your lab report is available for secure download via TeamBeam.",
  "folderId": "5976"
}

Explanation:

  • host, accessHost: Target instance of TeamBeam and the domain used by recipients to access the files.
  • adminUnit: Identifies the sending organisation.
  • credentials: Login for the service account (prefer app-specific passwords).
  • fileReferences: References to the files you want to transfer from your process.
  • receivers: Recipient list including name and delivery type (to, cc, bcc).
  • subject, description: Text snippets shown to recipients in TeamBeam notifications.
  • folderId: Destination folder within TeamBeam if you want to keep uploads organised.

Output

The task returns a transfer status and details about recipients and files.

{
  "status": 200,
  "transferStatus": "ok",
  "recipients": [
    {
      "email": "peter.velten@pantarey.io",
      "status": "delivered"
    }
  ],
  "files": [
    {
      "name": "labor-report.pdf",
      "size": 523812
    }
  ],
  "reservationToken": "TB-RES-8f2c1d",
  "host": "pro.teambeam.de",
  "receivers": [
    {
      "email": "peter.velten@pantarey.io",
      "accessLink": "https://sension.teambeam.pro/download/TB-RES-8f2c1d"
    }
  ]
}

Explanation:

  • transferStatus: Result of the transfer (ok indicates success).
  • recipients: Delivery status for each recipient.
  • files: Summary of the files published to TeamBeam.
  • reservationToken: Reference value for auditing and follow-up.
  • receivers: Contains the generated download links.

JSONata examples

{
  "fileReferences": $.documents.("s3://secure-bucket/" & filePath),
  "receivers": $.recipients.{
    "email": email,
    "name": name,
    "type": $exists(cc) and cc = true ? "cc" : "to"
  },
  "subject": "Secure transfer for " & $.caseId,
  "description": "Hi " & $.recipients[0].name & ", your document is now ready via TeamBeam.",
  "folderId": $.teambeam.folderId
}

Notes

  • Share only the personal data that is required to comply with GDPR expectations.
  • Store the TeamBeam password in your secret manager and reference it securely.
  • Notify recipients beforehand so they recognise the incoming TeamBeam link.

Tip

Validate your JSONata expressions in the JSONata Playground and verify the generated links in a test run.