Cleo Harmony

What you can build

• Notice when a supplier feed goes quiet

  The operator compares recent incoming transfers on each connection against that connection's usual rhythm and flags one that has stopped, naming the alias and the last meta.created time.

  With Integration Health, Inbound Delay

• Retry an errored transfer with the receipt attached

  A transfer ends in status error. The operator reads its events and receipt, then proposes POST /transfers/{transferId}/resend once the remote host answers. You approve; the resend runs once.

  With Integration Health, Webhook Replay

• Replace a certificate before AS2 exchanges fail

  Expiry dates are tracked on your side. The operator inventories certificates through GET /certs and proposes the import of the replacement CA certificate through POST /certs for your approval.

  With Certificate Expiry

• Confirm a purchase order file actually left

  After you approve a drafted purchase order, the operator watches the outgoing transfer on the supplier's connection and reports its status, bytes, and receipt, or proposes a resend when it errors.

  With Purchase Order Draft, PO Chase

Requirements

• A Cleo Harmony or Cleo VLTrader server whose REST API is reachable over HTTPS at https://{serverHostname}/api/
• A Harmony user whose credentials may call the API, plus two-factor codes supplied as totp_code where enabled
• Network reach to that server, since the API is served from your own host rather than a Cleo cloud endpoint
• Connections, mailboxes, and actions already configured in Harmony for your trading partners and internal systems

Authentication

Basic authentication, or a bearer token from POST /authentication with grant_type password, a Harmony username and password, and totp_code where two-factor authentication is on.

Limits

• The API documents no push mechanism. Events and transfers are polled, with count defaulting to 20 items per page.
• Documented response codes stop at 503. No rate limit or 429 behaviour is published, so pacing is set per deployment.
• The Events resource pages do not define event type names or a retention window; the connector keeps its own history.
• Lifetime and revocation of bearer tokens from POST /authentication are not documented.

Questions and answers

Does Cleo Harmony push events to Fibric?

The documented REST API is pull only. The connector polls GET /transfers and GET /events, or the per-connection GET /connections/{connectionId}/transfers, using filter, startIndex, count, sortBy, and sortOrder. Cleo documents no webhook resource.

How does the connector sign in?

With Basic authentication, or with a bearer token from POST /authentication using grant_type password, username, password, and totp_code when two-factor is on. The response carries access_token, refresh_token, token_type, and user_id. The token goes in the Authorization header on each call.

Which connection types does the API cover?

Protocol connections AS2, AS4, ebXML, FTP, FTPConnector, HTTP, OFTP, RNIF, SFTP, SFTPConnector, and SMTP; infrastructure connections such as AMQP, Azure Blob, File, GCS, HDFS, IBMMQ, Kafka, SMB, S3, and SharePoint; and product, authentication, and logging connections including LDAP, Datadog, and Splunk. Each has its own create, retrieve, modify, and clone endpoints.