External events let Membrane receive changes from an external application and deliver them to your workspace.An Event Source owns both the connection-specific event definition and its runtime registration: its JavaScript lifecycle can subscribe, handle, unsubscribe, and optionally refresh the external registration. Event Listeners route emitted events to routines or webhooks.
See the API reference for the Event Source and Event Listener endpoint surfaces.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Membrane Docs","colors":{"primary":"#0F766E","light":"#14B8A6","dark":"#115E59"},"logo":{"light":"https://mintcdn.com/membrane-agency/v4_djV_NCG0crn4V/logo/light.svg?fit=max\u0026auto=format\u0026n=v4_djV_NCG0crn4V\u0026q=85\u0026s=a4c17bd552331573d4e08fa32fd8a7c3","dark":"https://mintcdn.com/membrane-agency/v4_djV_NCG0crn4V/logo/dark.svg?fit=max\u0026auto=format\u0026n=v4_djV_NCG0crn4V\u0026q=85\u0026s=844105699cb6f6e7fc7497e5b06c60db"},"favicon":"https://mintcdn.com/membrane-agency/v4_djV_NCG0crn4V/favicon.svg?fit=max\u0026auto=format\u0026n=v4_djV_NCG0crn4V\u0026q=85\u0026s=4f09b330b12c9cb04a0ac52897c2aec7","api":{"playground":{"display":"interactive","proxy":false}},"navbar":{"links":[{"href":"https://changelog.getmembrane.com","label":"Changelog"}],"primary":{"type":"button","label":"Website","href":"https://getmembrane.com"}},"footer":{"socials":{"github":"https://github.com/membranehq"}},"icons":{"library":"fontawesome"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"membrane-agency","hasAudioNarration":false,"actualSubdomain":"membrane-agency","customDomains":["docs.membrane.agency"],"gitSource":{"type":"github","owner":"membranehq","repo":"platform","deployBranch":"main","contentDirectory":"docs/mintlify","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6a8d9d315717d6af20a472c4","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Reference","count":115},{"language":"default","tag":"Workspace Elements","count":103},{"language":"default","tag":"Guides","count":60},{"language":"default","tag":"Connectors","count":30},{"language":"default","tag":"Managing Membrane","count":16},{"language":"default","tag":"How Membrane Works","count":14},{"language":"default","tag":"Ways to Use Membrane","count":13},{"language":"default","tag":"Actions","count":13},{"language":"default","tag":"Connections","count":11},{"language":"default","tag":"References","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"reference/workspace-elements/external-events","slug":"/reference/workspace-elements/external-events","pageMetadata":{"title":"External Events","description":null,"href":"/reference/workspace-elements/external-events"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`External events let Membrane receive changes from an external application and deliver them to your workspace.`}),`\n`,_jsx(_components.p,{children:`An Event Source owns both the connection-specific event definition and its runtime registration: its JavaScript lifecycle can subscribe, handle, unsubscribe, and optionally refresh the external registration. Event Listeners route emitted events to routines or webhooks.`}),`\n`,_jsx(Heading,{level:`2`,id:`implementation-type`,children:`Implementation Type`}),`\n`,_jsxs(_components.p,{children:[`Event Sources currently support webhook-based registrations. A source owns the `,_jsx(_components.code,{children:`subscribe`}),`, `,_jsx(_components.code,{children:`handle`}),`, `,_jsx(_components.code,{children:`unsubscribe`}),`, and optional `,_jsx(_components.code,{children:`refresh`}),` function slots.`]}),`\n`,_jsx(Heading,{level:`2`,id:`api-operations`,children:`API Operations`}),`\n`,_jsx(_components.p,{children:`See the API reference for the Event Source and Event Listener endpoint surfaces.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"External Events","description":null,"href":"/reference/workspace-elements/external-events"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Implementation Type","slug":"implementation-type","depth":2,"children":[]},{"title":"API Operations","slug":"api-operations","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"membrane-agency","siteName":"Membrane Docs","title":"External Events - Membrane Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-25T13:49:12.432Z","originalFileLocation":"reference/workspace-elements/external-events.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Membrane Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/membrane-agency/AsMUTkTfLdg_QiLm/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/membrane-agency/AsMUTkTfLdg_QiLm/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/membrane-agency/AsMUTkTfLdg_QiLm/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/membrane-agency/AsMUTkTfLdg_QiLm/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/membrane-agency/AsMUTkTfLdg_QiLm/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/membrane-agency/AsMUTkTfLdg_QiLm/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/membrane-agency/AsMUTkTfLdg_QiLm/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/membrane-agency/AsMUTkTfLdg_QiLm/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/membrane-agency/AsMUTkTfLdg_QiLm/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"External Events - Membrane Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Membrane Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.membrane.agency/reference/workspace-elements/external-events\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://membrane-agency.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=External+Events\u0026amp;theme=ac4e529bd3284492f16dc7df\u0026amp;signature=28a27362cb1ac62d99dff0377e351166bfe16d56de7f99968cf0f4ad46aa562a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"External Events - Membrane Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://membrane-agency.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=External+Events\u0026amp;theme=ac4e529bd3284492f16dc7df\u0026amp;signature=28a27362cb1ac62d99dff0377e351166bfe16d56de7f99968cf0f4ad46aa562a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/membrane-agency/AsMUTkTfLdg_QiLm/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Membrane Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F766E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.membrane.agency/reference/workspace-elements/external-events\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/workspace-elements/external-events.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.membrane.agency/#organization\",\"name\":\"Membrane Docs\",\"url\":\"https://docs.membrane.agency\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/membrane-agency/v4_djV_NCG0crn4V/logo/light.svg?fit=max\u0026auto=format\u0026n=v4_djV_NCG0crn4V\u0026q=85\u0026s=a4c17bd552331573d4e08fa32fd8a7c3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.membrane.agency#website\",\"name\":\"Membrane Docs\",\"url\":\"https://docs.membrane.agency\",\"publisher\":{\"@id\":\"https://docs.membrane.agency/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.membrane.agency/reference/workspace-elements/external-events#webpage\",\"url\":\"https://docs.membrane.agency/reference/workspace-elements/external-events\",\"name\":\"External Events\",\"dateModified\":\"2026-08-25T13:49:12.432Z\",\"isPartOf\":{\"@id\":\"https://docs.membrane.agency#website\"},\"breadcrumb\":{\"@id\":\"https://docs.membrane.agency/reference/workspace-elements/external-events#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.membrane.agency/reference/workspace-elements/external-events#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Workspace Elements\",\"item\":\"https://docs.membrane.agency/api-reference/list-connections\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"External Events\",\"item\":\"https://docs.membrane.agency/reference/workspace-elements/external-events\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.membrane.agency/reference/workspace-elements/external-events#article\",\"headline\":\"External Events\",\"name\":\"External Events\",\"url\":\"https://docs.membrane.agency/reference/workspace-elements/external-events\",\"mainEntityOfPage\":{\"@id\":\"https://docs.membrane.agency/reference/workspace-elements/external-events#webpage\"},\"dateModified\":\"2026-08-25T13:49:12.432Z\",\"publisher\":{\"@id\":\"https://docs.membrane.agency/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.membrane.agency#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Membrane Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Membrane Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/getting-started/overview"}]},{"tab":"Reference","groups":[{"group":"Overview","pages":[{"title":"Authentication","href":"/reference/overview/authentication"},{"title":"Element Selectors","href":"/reference/overview/element-selectors"},{"title":"API Errors","href":"/reference/overview/errors"}]},{"group":"Workspace Elements","pages":[{"group":"Connections","root":{"title":"Connections","href":"/reference/workspace-elements/connections"},"pages":[{"title":"list-connections","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /connections","href":"/api-reference/list-connections"},{"title":"get-connection","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /connections/{id}","href":"/api-reference/get-connection"},{"title":"create-connection","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /connections","href":"/api-reference/create-connection"},{"title":"update-connection","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json patch /connections/{id}","href":"/api-reference/update-connection"},{"title":"replace-connection","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json put /connections/{id}","href":"/api-reference/replace-connection"},{"title":"test-connection","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /connections/{id}/test","href":"/api-reference/test-connection"},{"title":"refresh-connection","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /connections/{id}/refresh-credentials","href":"/api-reference/refresh-connection"},{"title":"export-connection","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /connections/{id}/export","href":"/api-reference/export-connection"},{"title":"delete-connection","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json delete /connections/{id}","href":"/api-reference/delete-connection"}]},{"group":"Connectors","root":{"title":"Connectors","href":"/reference/workspace-elements/connectors"},"pages":[{"group":"Connector Types","root":{"title":"Connector Types","href":"/reference/workspace-elements/connectors/connector-types"},"pages":[{"title":"Client Credentials","href":"/reference/workspace-elements/connectors/connector-types/client-credentials"},{"title":"Membrane Token","href":"/reference/workspace-elements/connectors/connector-types/membrane-token"},{"title":"OAuth1","href":"/reference/workspace-elements/connectors/connector-types/oauth1"},{"title":"OAuth2","href":"/reference/workspace-elements/connectors/connector-types/oauth2"},{"title":"Auth Proxy","href":"/reference/workspace-elements/connectors/connector-types/auth-proxy"}]},{"group":"Connector Functions","root":{"title":"Connector Functions","href":"/reference/workspace-elements/connectors/connector-functions"},"pages":[{"title":"Get Credentials from Connection Parameters","href":"/reference/workspace-elements/connectors/connector-functions/get-credentials-from-connection-parameters"},{"title":"Make API Client","href":"/reference/workspace-elements/connectors/connector-functions/make-api-client"},{"title":"Refresh Credentials","href":"/reference/workspace-elements/connectors/connector-functions/refresh-credentials"},{"title":"Test","href":"/reference/workspace-elements/connectors/connector-functions/test"},{"title":"Disconnect","href":"/reference/workspace-elements/connectors/connector-functions/disconnect"}]},{"title":"list-connectors","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /connectors","href":"/api-reference/list-connectors"},{"title":"list-public-connectors","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /universe/connectors","href":"/api-reference/list-public-connectors"},{"title":"get-connector","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /connectors/{idOrKey}","href":"/api-reference/get-connector"},{"title":"create-connector","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /connectors","href":"/api-reference/create-connector"},{"title":"update-connector","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json patch /connectors/{idOrKey}","href":"/api-reference/update-connector"},{"title":"delete-connector","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json delete /connectors/{idOrKey}","href":"/api-reference/delete-connector"},{"title":"Download connector as zip file","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /connectors/{idOrKey}/download","href":"/api-reference/connectors/download-connector-as-zip-file"},{"title":"Upload connector from zip file","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /connectors/{idOrKey}/upload","href":"/api-reference/connectors/upload-connector-from-zip-file"},{"title":"Import connector from external source","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /connectors/{idOrKey}/import","href":"/api-reference/connectors/import-connector-from-external-source"},{"title":"clone-connector","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /connectors/{idOrKey}/clone","href":"/api-reference/clone-connector"},{"title":"list-connector-versions","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /connectors/{key}/versions","href":"/api-reference/list-connector-versions"},{"title":"Publish a new version of connector","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /connectors/{key}/publish-version","href":"/api-reference/connectors/publish-a-new-version-of-connector"},{"title":"replace-connector","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json put /connectors/{idOrKey}","href":"/api-reference/replace-connector"},{"title":"Get a list of connector files","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /connectors/{idOrKey}/files","href":"/api-reference/connectors/get-a-list-of-connector-files"},{"title":"Get connector file by path","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /connectors/{idOrKey}/files/{path}","href":"/api-reference/connectors/get-connector-file-by-path"},{"title":"Update connector file","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json put /connectors/{idOrKey}/files/{path}","href":"/api-reference/connectors/update-connector-file"},{"title":"Delete connector file","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json delete /connectors/{idOrKey}/files/{path}","href":"/api-reference/connectors/delete-connector-file"},{"title":"Delete connector directory","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json delete /connectors/{idOrKey}/directories/{path}","href":"/api-reference/connectors/delete-connector-directory"},{"title":"Export connector as zip file","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /connectors/{idOrKey}/export-files","href":"/api-reference/connectors/export-connector-as-zip-file"},{"title":"Export connector as JSON","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /connectors/{idOrKey}/export-json","href":"/api-reference/connectors/export-connector-as-json"}]},{"group":"Integrations","root":{"title":"Integrations","href":"/reference/workspace-elements/integrations"},"pages":[{"group":"Integrations UI","root":{"title":"Integrations UI","href":"/reference/workspace-elements/integrations/integrations-catalog"},"pages":[{"title":"Custom Integrations Catalog UI","href":"/reference/workspace-elements/integrations/integrations-catalog/custom-list-of-integrations"},{"title":"Custom Integration UI","href":"/reference/workspace-elements/integrations/integrations-catalog/custom-integration-ui"}]},{"title":"List integrations","openapi":"GET /integrations","href":"/reference/workspace-elements/integrations/list-integrations"},{"title":"get-integration","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /integrations/{idOrKey}","href":"/api-reference/get-integration"}]},{"group":"Apps","root":{"title":"Apps","href":"/reference/workspace-elements/external-apps"},"pages":[{"title":"list-external-apps","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /external-apps","href":"/api-reference/list-external-apps"},{"title":"list-public-external-apps","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /universe/apps","href":"/api-reference/list-public-external-apps"},{"title":"get-external-app","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /external-apps/{idOrKeyOrUuid}","href":"/api-reference/get-external-app"},{"title":"create-external-app","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /external-apps","href":"/api-reference/create-external-app"},{"title":"update-external-app","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json patch /external-apps/{idOrKeyOrUuid}","href":"/api-reference/update-external-app"},{"title":"delete-external-app","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json delete /external-apps/{idOrKeyOrUuid}","href":"/api-reference/delete-external-app"}]},{"group":"Actions","root":{"title":"Actions","href":"/reference/workspace-elements/actions"},"pages":[{"title":"Act","openapi":"POST /act","href":"/reference/workspace-elements/act"},{"title":"list-actions","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /actions","href":"/api-reference/list-actions"},{"title":"get-action","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /actions/{selector}","href":"/api-reference/get-action"},{"title":"create-action","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /actions","href":"/api-reference/create-action"},{"title":"Update action partially","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json patch /actions/{selector}","href":"/api-reference/actions/update-action-partially"},{"title":"Replace action completely","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json put /actions/{selector}","href":"/api-reference/actions/replace-action-completely"},{"title":"Reset action","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /actions/{selector}/reset","href":"/api-reference/actions/reset-action"},{"title":"Clone action","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /actions/{selector}/clone","href":"/api-reference/actions/clone-action"},{"title":"Export action (flat interface)","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /actions/{selector}/export","href":"/api-reference/actions/export-action-flat-interface"},{"title":"Get dependencies of action (flat interface)","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /actions/{selector}/dependencies","href":"/api-reference/actions/get-dependencies-of-action-flat-interface"},{"title":"Restore action (flat interface)","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /actions/{selector}/restore","href":"/api-reference/actions/restore-action-flat-interface"},{"title":"Refresh action","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /actions/{selector}/refresh","href":"/api-reference/actions/refresh-action"},{"title":"Archive action","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json delete /actions/{selector}","href":"/api-reference/actions/archive-action"}]},{"group":"Data Links","root":{"title":"Data Links","href":"/reference/workspace-elements/data-links"},"pages":[{"title":"Data Link Table Instances","href":"/reference/workspace-elements/data-links/data-link-table-instances"}]},{"title":"Deliverables","href":"/reference/workspace-elements/deliverables"},{"group":"Field Mappings","root":{"title":"Field Mappings","href":"/reference/workspace-elements/field-mappings"},"pages":[{"title":"Field Mapping Instances","description":null,"href":"/reference/workspace-elements/field-mappings/field-mapping-instances"}]},{"group":"External Events","root":{"title":"External Events","href":"/reference/workspace-elements/external-events"},"pages":[{"title":"Webhook Events","description":null,"href":"/reference/workspace-elements/external-events/webhook"}]},{"group":"Flows","root":{"title":"Flows","href":"/reference/workspace-elements/flows"},"pages":[{"title":"Trigger Nodes","href":"/reference/workspace-elements/flows/trigger-nodes"},{"title":"Function Nodes","href":"/reference/workspace-elements/flows/function-nodes"},{"title":"Control Nodes","href":"/reference/workspace-elements/flows/control-nodes"},{"group":"Flow UI","root":{"title":"Flow UI","href":"/reference/workspace-elements/flows/flow-ui"},"pages":[{"title":"Custom Flow UI","href":"/reference/workspace-elements/flows/flow-ui/custom-flow-ui"},{"title":"Configure Flow Instance Parameters","href":"/reference/workspace-elements/flows/flow-ui/configure-flow-instance-parameters"},{"title":"Enable and Disable Flow Instances","href":"/reference/workspace-elements/flows/flow-ui/enable-and-disable-flow-instances-to"}]}]},{"group":"Tenants","root":{"title":"Tenants","href":"/reference/workspace-elements/tenants"},"pages":[{"title":"list-tenants","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /tenants","href":"/api-reference/list-tenants"},{"title":"create-tenant","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /tenants","href":"/api-reference/create-tenant"},{"title":"get-tenant","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /tenants/{id}","href":"/api-reference/get-tenant"},{"title":"update-tenant","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json patch /tenants/{id}","href":"/api-reference/update-tenant"},{"title":"replace-tenant","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json put /tenants/{id}","href":"/api-reference/replace-tenant"},{"title":"delete-tenant","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json delete /tenants/{id}","href":"/api-reference/delete-tenant"},{"title":"restore-tenant","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /tenants/{elementSelector}/restore","href":"/api-reference/restore-tenant"}]},{"group":"Search","root":{"title":"Search","href":"/reference/workspace-elements/search"},"pages":[{"title":"Search workspace elements by keyword","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /search","href":"/api-reference/workspaceelementssearch/search-workspace-elements-by-keyword"},{"title":"Search workspace elements using semantic similarity","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /semantic-search","href":"/api-reference/workspaceelementssearch/search-workspace-elements-using-semantic-similarity"}]},{"group":"Agent Sessions","root":{"title":"Agent Sessions","href":"/reference/workspace-elements/sessions"},"pages":[{"title":"List agent sessions","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /agent-sessions","href":"/api-reference/sessions/list-agent-sessions"},{"title":"Create a new agent session","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /agent-sessions","href":"/api-reference/sessions/create-a-new-agent-session"},{"title":"Get an agent session","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /agent-sessions/{id}","href":"/api-reference/sessions/get-an-agent-session"},{"title":"Update an agent session","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json patch /agent-sessions/{id}","href":"/api-reference/sessions/update-an-agent-session"},{"title":"Send a message to a session (resumes if stopped, sends input if running)","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /agent-sessions/{id}/message","href":"/api-reference/sessions/send-a-message-to-a-session-resumes-if-stopped-sends-input-if-running"},{"title":"Stop an agent session","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json patch /agent-sessions/{id}/stop","href":"/api-reference/sessions/stop-an-agent-session"},{"title":"Interrupt a running agent session","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /agent-sessions/{id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-agent-session"}]},{"group":"Action Run Logs","root":{"title":"Action Run Logs","href":"/reference/workspace-elements/action-run-logs"},"pages":[{"title":"list-action-run-logs","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /action-run-logs","href":"/api-reference/list-action-run-logs"},{"title":"get-action-run-log","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /action-run-logs/{id}","href":"/api-reference/get-action-run-log"},{"title":"Get action run log details","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /action-run-logs/{id}/details","href":"/api-reference/actionrunlogs/get-action-run-log-details"}]},{"group":"External API Logs","root":{"title":"External API Logs","href":"/reference/workspace-elements/external-api-logs"},"pages":[{"title":"List external API logs","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /external-api-logs","href":"/api-reference/externalapilogs/list-external-api-logs"},{"title":"Get API log by ID","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /external-api-logs/{id}","href":"/api-reference/externalapilogs/get-api-log-by-id"},{"title":"Get API log content","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /external-api-logs/{id}/details","href":"/api-reference/externalapilogs/get-api-log-content"}]},{"group":"External Event Logs","root":{"title":"External Event Logs","href":"/reference/workspace-elements/external-event-logs"},"pages":[{"title":"list-external-event-log-records","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /external-event-log-records","href":"/api-reference/list-external-event-log-records"},{"title":"get-external-event-log-record","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /external-event-log-records/{id}","href":"/api-reference/get-external-event-log-record"},{"title":"Get external event log record details","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /external-event-log-records/{id}/details","href":"/api-reference/externaleventlogrecords/get-external-event-log-record-details"}]},{"group":"External Event Pulls","root":{"title":"External Event Pulls","href":"/reference/workspace-elements/external-event-pulls"},"pages":[{"title":"List external event pulls","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /external-event-pulls","href":"/api-reference/externaleventpulls/list-external-event-pulls"},{"title":"Get external event pull","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /external-event-pulls/{id}","href":"/api-reference/externaleventpulls/get-external-event-pull"},{"title":"Get external event pull logs","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /external-event-pulls/{id}/logs","href":"/api-reference/externaleventpulls/get-external-event-pull-logs"}]},{"group":"Incoming Webhooks","root":{"title":"Incoming Webhooks","href":"/reference/workspace-elements/incoming-webhooks"},"pages":[{"title":"List incoming webhooks","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /incoming-webhooks","href":"/api-reference/incomingwebhooksreader/list-incoming-webhooks"},{"title":"Get incoming webhook by ID","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /incoming-webhooks/{id}","href":"/api-reference/incomingwebhooksreader/get-incoming-webhook-by-id"},{"title":"Get incoming webhook details","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /incoming-webhooks/{id}/details","href":"/api-reference/incomingwebhooksreader/get-incoming-webhook-details"}]}]},{"group":"Management API","pages":[{"group":"Workspace Provisioning","root":{"title":"Workspace Provisioning","href":"/reference/management-api/workspace-provisioning"},"pages":[{"title":"create-org-workspace","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /org-workspaces","href":"/api-reference/create-org-workspace"},{"title":"get-org-workspace","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /org-workspaces/{id}","href":"/api-reference/get-org-workspace"},{"title":"update-org-workspace","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json patch /org-workspaces/{id}","href":"/api-reference/update-org-workspace"},{"title":"create-org-workspace-access-token","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /org-workspaces/{id}/access-token","href":"/api-reference/create-org-workspace-access-token"},{"title":"archive-org-workspace","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json delete /org-workspaces/{id}","href":"/api-reference/archive-org-workspace"},{"title":"restore-org-workspace","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /org-workspaces/{id}/restore","href":"/api-reference/restore-org-workspace"},{"title":"rotate-org-workspace-secret","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /org-workspaces/{id}/rotate-secret","href":"/api-reference/rotate-org-workspace-secret"}]},{"group":"Workspace Migration","root":{"title":"Workspace Migration","href":"/reference/management-api/workspace-migration"},"pages":[{"title":"Export all workspace elements","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json get /export","href":"/api-reference/exportmembraneinterfaces/export-all-workspace-elements"},{"title":"Import workspace elements from membrane zip file","deprecated":null,"version":null,"openapi":"/api-reference/membrane-api.json post /import","href":"/api-reference/importmembraneinterfaces/import-workspace-elements-from-membrane-zip-file"}]}]}]}]},"basePath":"","title":"External Events - Membrane Docs","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":[],"chunks":[]}