Create a new API key from Settings → Developer → API Keys and assign the scopes your integration needs. Existing legacy keys continue working during the transition period.
If you encounter issues during migration, contact developer-support@essal.cloud with your workspace ID and a description of the issue.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Essal Developer Docs","colors":{"primary":"#0066FF","light":"#3D8BFF","dark":"#0050B4"},"logo":{"light":"https://mintcdn.com/essal/5qVV5p4Y6tAbM76k/logo/logo.svg?fit=max\u0026auto=format\u0026n=5qVV5p4Y6tAbM76k\u0026q=85\u0026s=706e0f6b7817c8a2af008f21830be42b","dark":"https://mintcdn.com/essal/5qVV5p4Y6tAbM76k/logo/logo.svg?fit=max\u0026auto=format\u0026n=5qVV5p4Y6tAbM76k\u0026q=85\u0026s=706e0f6b7817c8a2af008f21830be42b","href":"https://essal.cloud"},"favicon":"https://mintcdn.com/essal/McBxieepy9CPQ7G0/favicon.png?fit=max\u0026auto=format\u0026n=McBxieepy9CPQ7G0\u0026q=85\u0026s=10fba0b2f9e4f93957e9338d17ef82cb","api":{"playground":{}},"background":{},"footer":{"socials":{"github":"https://github.com/essal","facebook":"https://facebook.com/essal","linkedin":"https://www.linkedin.com/company/essal"},"links":[{"items":[{"label":"Office","href":"https://essal.cloud/products/office"},{"label":"Access","href":"https://essal.cloud/products/access"},{"label":"Sales","href":"https://essal.cloud/products/sales"},{"label":"Careers","href":"https://essal.cloud/products/careers"},{"label":"Project","href":"https://essal.cloud/products/project"},{"label":"Guard","href":"https://essal.cloud/products/guard"}]},{"items":[{"label":"Help Center","href":"https://support.essal.cloud"},{"label":"Training","href":"https://essal.cloud/training"},{"label":"Security Center","href":"https://essal.cloud/security"},{"label":"Legal Center","href":"https://legal.essal.cloud/"},{"label":"Certifications","href":"https://credentials.essal.cloud/"}]},{"items":[{"label":"About Us","href":"https://essal.cloud/about"},{"label":"Careers","href":"https://careers.essal.cloud/"},{"label":"Newsroom","href":"https://newsroom.essal.cloud/"},{"label":"Become a Partner","href":"https://essal.cloud/partners"},{"label":"Brand Assets","href":"https://brand.essal.cloud/"},{"label":"Contact","href":"https://essal.cloud/contact"}]},{"items":[{"label":"Privacy","href":"https://legal.essal.cloud/privacy"},{"label":"Terms of use","href":"https://legal.essal.cloud/terms"},{"label":"Leave Feedback","href":"https://review.essal.cloud/"},{"label":"Status Page","href":"https://status.essal.cloud/"}]}]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"essal","hasAudioNarration":false,"actualSubdomain":"essal","customDomains":["developers.essal.cloud"],"gitSource":{"type":"github","owner":"essalhq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"4d503a57-591d-47e7-9d7d-1abd2ae897c8","liveDeploymentHistoryId":"6a5383090b5bb62de3ce1c58","schemaVersion":"v3"},"entitlements":{},"buildId":"6a5383090b5bb62de3ce1c58:success","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Documentation","count":38},{"language":"default","tag":"API Reference","count":23},{"language":"default","tag":"SDKs \u0026 Tools","count":8},{"language":"default","tag":"Platform Concepts","count":6},{"language":"default","tag":"Getting Started","count":5},{"language":"default","tag":"Integrations","count":5},{"language":"default","tag":"Official SDKs","count":5},{"language":"default","tag":"Webhooks","count":4},{"language":"default","tag":"Changelog","count":4},{"language":"default","tag":"Changelog Updates","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"a[href*=\"mintlify.com?utm_campaign=poweredBy\"]{display:none!important}"}],"page":{"pagePath":"support/migration-guide","slug":"/support/migration-guide","pageMetadata":{"title":"Migration Guide","description":"Guide for teams migrating existing integrations to the Essal v1 API.","href":"/support/migration-guide"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Guide for teams migrating existing integrations to the Essal v1 API.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`This guide covers how to migrate from earlier Essal API versions or from third-party tools to the Essal v1 API across all six apps.`}),`\n`,_jsx(Heading,{level:`2`,id:`what-changed-in-v1`,children:`What Changed in v1`}),`\n`,_jsx(_components.p,{children:`v1 is a full redesign of the Essal API. Key changes from the legacy API:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Legacy`}),_jsx(_components.th,{children:`v1`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Separate base URLs per app`}),_jsxs(_components.td,{children:[`Single base URL: `,_jsx(_components.code,{children:`https://api.essal.cloud/v1`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Per-app API keys`}),_jsx(_components.td,{children:`Single workspace API key with scopes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`App-specific auth headers`}),_jsxs(_components.td,{children:[`Unified `,_jsx(_components.code,{children:`X-API-Key`}),` or `,_jsx(_components.code,{children:`Authorization: Bearer`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Inconsistent pagination`}),_jsx(_components.td,{children:`Cursor-based pagination on all list endpoints`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`No cross-app references`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`linked_resources`}),` on all entities`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Per-app webhook subscriptions`}),_jsxs(_components.td,{children:[`Single `,_jsx(_components.code,{children:`/v1/webhooks`}),` endpoint for all events`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`step-by-step-migration`,children:`Step-by-Step Migration`}),`\n`,_jsx(Heading,{level:`3`,id:`1-generate-a-v1-api-key`,children:`1. Generate a v1 API Key`}),`\n`,_jsxs(_components.p,{children:[`Create a new API key from `,_jsx(_components.strong,{children:`Settings → Developer → API Keys`}),` and assign the scopes your integration needs. Existing legacy keys continue working during the transition period.`]}),`\n`,_jsx(Heading,{level:`3`,id:`2-update-the-base-url`,children:`2. Update the Base URL`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`diff`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`diff`,children:_jsxs(_components.code,{language:`diff`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-dark\":`#CE9178`},children:`- https://office.api.essal.cloud/v1/documents`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#B5CEA8`},children:`+ https://api.essal.cloud/v1/office/documents`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`All endpoints follow the pattern `,_jsx(_components.code,{children:`/v1/{app}/{resource}`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`3-update-the-auth-header`,children:`3. Update the Auth Header`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`diff`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`diff`,children:_jsxs(_components.code,{language:`diff`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-dark\":`#CE9178`},children:`- X-Office-API-Key: legacy_key`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#B5CEA8`},children:`+ X-API-Key: esk_live_xxxxxxxxxxxxxxxxxxxx`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`4-update-pagination-logic`,children:`4. Update Pagination Logic`}),`\n`,_jsxs(_components.p,{children:[`List endpoints previously returned `,_jsx(_components.code,{children:`page`}),` and `,_jsx(_components.code,{children:`total_pages`}),`. v1 uses cursor-based pagination:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`diff`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`diff`,children:_jsxs(_components.code,{language:`diff`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-dark\":`#CE9178`},children:`- GET /v1/documents?page=2\u0026per_page=20`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#B5CEA8`},children:`+ GET /v1/office/documents?cursor=doc_01HXYZ5555\u0026limit=20`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Read the `,_jsx(_components.code,{children:`meta.next_cursor`}),` from each response and pass it as `,_jsx(_components.code,{children:`cursor`}),` in the next request.`]}),`\n`,_jsx(Heading,{level:`3`,id:`5-migrate-webhook-subscriptions`,children:`5. Migrate Webhook Subscriptions`}),`\n`,_jsx(_components.p,{children:`Delete per-app webhook subscriptions and create a unified subscription:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` /v1/webhooks`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://your-endpoint.example.com/essal\",`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` \"events\"`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"office.document.created\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"sales.deal.won\",`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"guard.alert.triggered\"]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`transition-period`,children:`Transition Period`}),`\n`,_jsxs(_components.p,{children:[`Legacy API endpoints remain available until `,_jsx(_components.strong,{children:`December 31, 2026`}),`. After that date, all legacy endpoints will return `,_jsx(_components.code,{children:`410 Gone`}),`.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Begin migrating now. The transition period will not be extended. Legacy API keys will stop working at the same time as the legacy endpoints.`})}),`\n`,_jsx(Heading,{level:`2`,id:`support-during-migration`,children:`Support During Migration`}),`\n`,_jsxs(_components.p,{children:[`If you encounter issues during migration, contact `,_jsx(_components.a,{href:`mailto:developer-support@essal.cloud`,children:`developer-support@essal.cloud`}),` with your workspace ID and a description of the issue.`]})]})}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":"Migration Guide","description":"Guide for teams migrating existing integrations to the Essal v1 API.","href":"/support/migration-guide"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"What Changed in v1","slug":"what-changed-in-v1","depth":2,"children":[]},{"title":"Step-by-Step Migration","slug":"step-by-step-migration","depth":2,"children":[{"title":"1. Generate a v1 API Key","slug":"1-generate-a-v1-api-key","depth":3,"children":[]},{"title":"2. Update the Base URL","slug":"2-update-the-base-url","depth":3,"children":[]},{"title":"3. Update the Auth Header","slug":"3-update-the-auth-header","depth":3,"children":[]},{"title":"4. Update Pagination Logic","slug":"4-update-pagination-logic","depth":3,"children":[]},{"title":"5. Migrate Webhook Subscriptions","slug":"5-migrate-webhook-subscriptions","depth":3,"children":[]}]},{"title":"Transition Period","slug":"transition-period","depth":2,"children":[]},{"title":"Support During Migration","slug":"support-during-migration","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"essal","siteName":"Essal Developer Docs","title":"Migration Guide - Essal Developer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-12T12:05:47.275Z","originalFileLocation":"support/migration-guide.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=\"description\" content=\"Guide for teams migrating existing integrations to the Essal v1 API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Essal Developer 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/essal/hV1lHJlq_XIJhUPP/_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/essal/hV1lHJlq_XIJhUPP/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/essal/hV1lHJlq_XIJhUPP/_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/essal/hV1lHJlq_XIJhUPP/_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/essal/hV1lHJlq_XIJhUPP/_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/essal/hV1lHJlq_XIJhUPP/_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/essal/hV1lHJlq_XIJhUPP/_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/essal/hV1lHJlq_XIJhUPP/_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/essal/hV1lHJlq_XIJhUPP/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Migration Guide - Essal Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Guide for teams migrating existing integrations to the Essal v1 API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Essal Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.essal.cloud/support/migration-guide\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://essal.mintlify.app/_mintlify/api/og/v2?division=Resources\u0026amp;title=Migration+Guide\u0026amp;description=Guide+for+teams+migrating+existing+integrations+to+the+Essal+v1+API.\u0026amp;theme=d5c245af879c7f969a007e7d\u0026amp;signature=1fc971f22cfb70c0857b2cee446a265f51571eb146cefc799b8a68d640367837\">\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=\"Migration Guide - Essal Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Guide for teams migrating existing integrations to the Essal v1 API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://essal.mintlify.app/_mintlify/api/og/v2?division=Resources\u0026amp;title=Migration+Guide\u0026amp;description=Guide+for+teams+migrating+existing+integrations+to+the+Essal+v1+API.\u0026amp;theme=d5c245af879c7f969a007e7d\u0026amp;signature=1fc971f22cfb70c0857b2cee446a265f51571eb146cefc799b8a68d640367837\">\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/essal/hV1lHJlq_XIJhUPP/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Essal Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0066FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.essal.cloud/support/migration-guide\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/support/migration-guide.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.essal.cloud/#organization\",\"name\":\"Essal Developer Docs\",\"url\":\"https://developers.essal.cloud\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/essal/5qVV5p4Y6tAbM76k/logo/logo.svg?fit=max\u0026auto=format\u0026n=5qVV5p4Y6tAbM76k\u0026q=85\u0026s=706e0f6b7817c8a2af008f21830be42b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.essal.cloud#website\",\"name\":\"Essal Developer Docs\",\"url\":\"https://developers.essal.cloud\",\"publisher\":{\"@id\":\"https://developers.essal.cloud/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.essal.cloud/support/migration-guide#webpage\",\"url\":\"https://developers.essal.cloud/support/migration-guide\",\"name\":\"Migration Guide\",\"description\":\"Guide for teams migrating existing integrations to the Essal v1 API.\",\"dateModified\":\"2026-07-12T12:05:47.275Z\",\"isPartOf\":{\"@id\":\"https://developers.essal.cloud#website\"},\"breadcrumb\":{\"@id\":\"https://developers.essal.cloud/support/migration-guide#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.essal.cloud/support/migration-guide#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Resources\",\"item\":\"https://developers.essal.cloud/support/status\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Migration Guide\",\"item\":\"https://developers.essal.cloud/support/migration-guide\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://developers.essal.cloud/support/migration-guide#article\",\"headline\":\"Migration Guide\",\"name\":\"Migration Guide\",\"description\":\"Guide for teams migrating existing integrations to the Essal v1 API.\",\"url\":\"https://developers.essal.cloud/support/migration-guide\",\"mainEntityOfPage\":{\"@id\":\"https://developers.essal.cloud/support/migration-guide#webpage\"},\"dateModified\":\"2026-07-12T12:05:47.275Z\",\"publisher\":{\"@id\":\"https://developers.essal.cloud/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.essal.cloud#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Essal Developer Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Essal Developer Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/overview"}]},{"tab":"SDKs \u0026 Tools","pages":[{"title":"SDKs \u0026 Tools","href":"/sdks/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/2026-07-01"}]},{"tab":"Support","groups":[{"group":"Resources","pages":[{"title":"System Status","href":"/support/status"},{"title":"FAQ","description":"Frequently asked questions about the Essal developer platform and API.","href":"/support/faq"},{"title":"Migration Guide","href":"/support/migration-guide"},{"title":"Developer Support","description":"Get help with your Essal integration — channels, response times, and how to report issues.","href":"/support/contact"}]}]}]},"basePath":"","title":"Migration Guide - Essal Developer Docs","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":[],"chunks":[]}
