Repository navigation
Sync docs with API 2026-05-25 (SDK 2.1.0/2.2.0) - #1
Merged
Merged
Conversation
- Connection (Client) response no longer returns credentials: drop sftpPassword / sftpPrivateKey / sftpPassphrase / awsPassword from the response schema (they are write-only). - CreateWebhookParams: remove eventType + secret and require only name/url; the server defaults eventType to GENERAL and generates the secret. - PipelineRunStatus: add "delivered" (outbound terminal status). - InitOutboundUploadParams: add outputFilename + outputFormat (csv|json|xml); document output resolution and that clientName is the awsUserName slug. - Document connections.getByName(name) across SDK reference pages.
…ctions-webhooks-outbound # Conflicts: # automated-flows/outbound.mdx
…edential-strip, SDK 2.1.0/2.2.0 under 2026-05-25
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings the public docs + OpenAPI in line with the API/SDK changes shipped in SDK 2.1.0 and 2.2.0 (API version 2026-05-25).
Corrections (docs were wrong):
Clientresponse schema no longer advertisessftpPassword/sftpPrivateKey/sftpPassphrase/awsPassword— these are write-only and the API never returns them.CreateWebhookParamsdropseventType+secret(API rejects unknown props); onlyname+urlrequired. Server defaultseventTypetoGENERALand generatessecret.eventType).Additions (were missing):
PipelineRunStatusgainsdelivered(outbound terminal status).InitOutboundUploadParamsgainsoutputFilename+outputFormat(csv|json|xml); outbound guide documents output resolution and thatclientNameis theawsUserNameslug.connections.getByName(name)documented across SDK reference pages.Notes
openapi.jsonvalidated as well-formed JSON.