Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getmembrane.com/llms.txt

Use this file to discover all available pages before exploring further.

Integration Packages are collections of integration elements. Packages can be organized around external apps (i.e. “Integration with Github”), integration scenarios (i.e. “Unified API for Tasks”), product features (i.e. “Documents Import”) or any other grouping. Example of a package: 
name: Continuously Import Users
shortDescription: Import users from external app and keep them in sync by monitoring events.
description: <Long description explaining the scenario in detail>
elements:
  - type: action
    id: <action id>
  - type: flow
    id: <flow id>
Packages can be universal (work across multiple integrations) and integration-specific. When a universal package is applied to a given integration (by creating a child package for that integration that has parentId pointing to the universal one), elements of the integration-specific packages are automatically generated and the list of elements can only be changed in the parent package.

​
API Operations

OperationMethodEndpointDescription
List all packagesGET/packagesRetrieve all available packages
Get packageGET/packages/{selector}Get specific package details
Create a new packagePOST/packagesCreate a new package
Replace packagePUT/packages/{selector}Replace package configuration
Patch packagePATCH/packages/{selector}Update package partially
Clone packagePOST/packages/{selector}/cloneClone an existing package
Reset packagePOST/packages/{selector}/resetReset package to default
Export packageGET/packages/{selector}/exportExport package configuration
Get package dependenciesGET/packages/{selector}/dependenciesGet package dependencies
Restore packagePOST/packages/{selector}/restoreRestore archived package
Refresh packagePOST/packages/{selector}/refreshRefresh package from source
Archive packageDELETE/packages/{selector}Archive a package