(Beta) Create a Micro-Integration Definition

Creates a Micro-Integration Definition, its Connection and its first version in a single request: the Definition is the stable identity of a deployable composition of Workflows, and the Connection and Workflow composition belong to its version 1. Creation is atomic - if any part is rejected, none of them is created.

The name is required and must be unique within your organization. The version's Connection takes the same body as POST /microIntegrationConnections, and its microIntegrationType and microIntegrationVersion must match those of every Workflow Definition Version listed in the composition. The composition is optional: without Workflow Definition Versions, version 1 has none, and they can be attached through a new version.

If the Connection's configurationValues reference a file-type field (e.g. a certificate or a private key), upload the matching file(s) as additional multipart parts. Each file's original filename must match the filename given in configurationValues; the multipart part name is ignored.

A validation error names the part that was rejected (the Connection or the version) and the field.



Token Permissions: [ micro_integrations: ]

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
microIntegrationDefinition
object
required
files
array of files
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*