A Portal Link is used to generate a customer-facing dashboard to display information
on an endpoint’s event deliveries. The portal link serves as a medium to quickly generate
portals for users to review and debug events from a publisher. You can generate one
time links via the dashboard or long-use links to be embedded in your dashboards via the API.”A portal link can be created for one or more endpoints.
Once a portal link is created, the link can be copied from the same page or the portal links page.
The event deliveries associated with the endpoint are listed. These events can be filtered, retried and expanded upon to view more details.
Portal Links do not expire, to disable you have to explicitly call the API or disable it through the dashboard.
Portal Links can be created for one or more endpoints.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Convoy","colors":{"primary":"#2780F1","light":"#739FEA","dark":"#477BD3"},"logo":{"light":"https://mintcdn.com/convoy/ZDnFuM112cm76jYI/logo/light.svg?fit=max\u0026auto=format\u0026n=ZDnFuM112cm76jYI\u0026q=85\u0026s=3d933080cf301678d7fafe5f50d4ec12","dark":"https://mintcdn.com/convoy/vmJyPsa9GtTKdw-a/logo/dark.svg?fit=max\u0026auto=format\u0026n=vmJyPsa9GtTKdw-a\u0026q=85\u0026s=7d0ea6ef778d7ed00854dc455e9b12ea"},"favicon":"https://mintcdn.com/convoy/Ckv6F6QCAG1QB-UF/favicon.png?fit=max\u0026auto=format\u0026n=Ckv6F6QCAG1QB-UF\u0026q=85\u0026s=cc975351cd155c7828899933dca4f999","background":{"image":"https://mintcdn.com/convoy/Ckv6F6QCAG1QB-UF/background.png?fit=max\u0026auto=format\u0026n=Ckv6F6QCAG1QB-UF\u0026q=85\u0026s=165fcf2460dff22b7e1c8d84d0741646"},"navbar":{"primary":{"type":"github","label":"GitHub","href":"https://github.com/frain-dev/convoy"}},"footer":{"socials":{"twitter":"https://twitter.com/getconvoy?lang=en","linkedin":"https://www.linkedin.com/company/convoy-webhooks"}},"seo":{"metatags":{"canonical":"https://www.getconvoy.io/docs"}},"integrations":{"posthog":{"apiKey":"phc_X7uV1sRNzjoTmWp8uXYrzrfrdUtGdMRTEEklRNt04eb","apiHost":"https://us.i.posthog.com"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://convoy-community.slack.com/join/shared_invite/zt-xiuuoj0m-yPp~ylfYMCV9s038QL0IUQ#/shared-invite/email"},{"anchor":"GitHub","icon":"github","href":"https://github.com/frain-dev/convoy"},{"anchor":"Status","icon":"signal","href":"https://status.getconvoy.io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"convoy","hasAudioNarration":false,"actualSubdomain":"convoy","customDomains":["getconvoy.io"],"gitSource":{"type":"github","owner":"frain-dev","repo":"convoy-website","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":false,"issues":false},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae50032dbe71608b89029e5","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Reference","count":70},{"language":"default","tag":"Documentation","count":68},{"language":"default","tag":"Product Manual","count":28},{"language":"default","tag":"Glossary","count":13},{"language":"default","tag":"Endpoints","count":9},{"language":"default","tag":"Events","count":8},{"language":"default","tag":"Subscription Filters","count":8},{"language":"default","tag":"Deployment","count":8},{"language":"default","tag":"Subscriptions","count":7},{"language":"default","tag":"Portal Links","count":6}]},"assistantConfig":{},"basePath":"/docs","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":"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":"product-manual/portal-links","slug":"/product-manual/portal-links","pageMetadata":{"title":"Portal Links","og:title":"Portal Links","og:description":"The portal link serves as a medium to quickly generate portals for users to review and debug events from a publisher","twitter:description":"The portal link serves as a medium to quickly generate portals for users to review and debug events from a publisher","twitter:url":"https://getconvoy.io/docs/product-manual/portal-links","description":null,"href":"/product-manual/portal-links"},"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={li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Frame,Heading,OptimizedImage}=_components;if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`A Portal Link is used to generate a customer-facing dashboard to display information\non an endpoint’s event deliveries. The portal link serves as a medium to quickly generate\nportals for users to review and debug events from a publisher. You can generate one\ntime links via the dashboard or long-use links to be embedded in your dashboards via the API.”`}),`\n`,_jsx(_components.p,{children:`A portal link can be created for one or more endpoints.`}),`\n`,_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/convoy/Ckv6F6QCAG1QB-UF/images/create-portal-link.png?fit=max\u0026auto=format\u0026n=Ckv6F6QCAG1QB-UF\u0026q=85\u0026s=fd593f8e7e251b7ad5227d35a3e0c1ec`,alt:`Create portal link`,\"data-og-width\":`1026`,width:`1026`,\"data-og-height\":`670`,height:`670`,\"data-path\":`images/create-portal-link.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/convoy/Ckv6F6QCAG1QB-UF/images/create-portal-link.png?w=280\u0026fit=max\u0026auto=format\u0026n=Ckv6F6QCAG1QB-UF\u0026q=85\u0026s=f512a3cc11b1415e36150090e0abf0c9 280w, https://mintcdn.com/convoy/Ckv6F6QCAG1QB-UF/images/create-portal-link.png?w=560\u0026fit=max\u0026auto=format\u0026n=Ckv6F6QCAG1QB-UF\u0026q=85\u0026s=45b4e5d42411d76ef96919e08cbb8f6a 560w, https://mintcdn.com/convoy/Ckv6F6QCAG1QB-UF/images/create-portal-link.png?w=840\u0026fit=max\u0026auto=format\u0026n=Ckv6F6QCAG1QB-UF\u0026q=85\u0026s=2c0d7293097bfc6f74662d90ab1d0569 840w, https://mintcdn.com/convoy/Ckv6F6QCAG1QB-UF/images/create-portal-link.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Ckv6F6QCAG1QB-UF\u0026q=85\u0026s=7430361c3be3be898e572601ff55f8b6 1100w, https://mintcdn.com/convoy/Ckv6F6QCAG1QB-UF/images/create-portal-link.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Ckv6F6QCAG1QB-UF\u0026q=85\u0026s=3da98f9be8f01875beba8aef2211eeb9 1650w, https://mintcdn.com/convoy/Ckv6F6QCAG1QB-UF/images/create-portal-link.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Ckv6F6QCAG1QB-UF\u0026q=85\u0026s=777f9669546fd01d9f70b428c42b6030 2500w`})}),`\n`,_jsx(_components.p,{children:`Once a portal link is created, the link can be copied from the same page or the portal links page.`}),`\n`,_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/new-portal-link.png?fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=7f505d8c1cb719f812e0431aeba9f36b`,alt:`New portal link`,\"data-og-width\":`1726`,width:`1726`,\"data-og-height\":`1038`,height:`1038`,\"data-path\":`images/new-portal-link.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/new-portal-link.png?w=280\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=d83515efd7b9359fcc56b5bc99505708 280w, https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/new-portal-link.png?w=560\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=246e12467577c1d38f77be06a9d69acd 560w, https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/new-portal-link.png?w=840\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=978b8bbce6c8cd5a60c78080a8b37a0b 840w, https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/new-portal-link.png?w=1100\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=56416f9d315a904c77dcada316601385 1100w, https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/new-portal-link.png?w=1650\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=8c963bb397a3442482c2002484d3b818 1650w, https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/new-portal-link.png?w=2500\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=0bb9252d463f8a3eef0529a4131ce749 2500w`})}),`\n`,_jsx(`br`,{}),`\n`,_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/portal-link.png?fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=3089c68fdafdfcc1b196f71b009373b3`,alt:`Portal links`,\"data-og-width\":`1726`,width:`1726`,\"data-og-height\":`1038`,height:`1038`,\"data-path\":`images/portal-link.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/portal-link.png?w=280\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=dd6b3c11d92d489a9ad5be52f6a93a25 280w, https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/portal-link.png?w=560\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=41d6a604cff75eedadc0e7c825d2de32 560w, https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/portal-link.png?w=840\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=4d12c22a48dc0755e5a7c5622b52f2d9 840w, https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/portal-link.png?w=1100\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=61301b72fdb1ff6f9e6f254f3ef63a76 1100w, https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/portal-link.png?w=1650\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=cd51e18a71402de7b6afd850aed30b70 1650w, https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/portal-link.png?w=2500\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=48726649344812329ced7f3e5879ad90 2500w`})}),`\n`,_jsx(_components.p,{children:`The event deliveries associated with the endpoint are listed. These events can be filtered, retried and expanded upon to view more details.`}),`\n`,_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/portal-event-deliveries.png?fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=fba99e16fa96e6a4aed7d57efe959593`,alt:`Dashboard spun from a portal link`,\"data-og-width\":`2040`,width:`2040`,\"data-og-height\":`1138`,height:`1138`,\"data-path\":`images/portal-event-deliveries.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/portal-event-deliveries.png?w=280\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=2ed63701f83567b781eb8885885f8e62 280w, https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/portal-event-deliveries.png?w=560\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=d48f4aeff05baa8a5d8f937c4470cf2e 560w, https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/portal-event-deliveries.png?w=840\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=b61abced316c40cb7bb24549ae857c32 840w, https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/portal-event-deliveries.png?w=1100\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=27d1750b676f4320ff3bf372a2411447 1100w, https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/portal-event-deliveries.png?w=1650\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=cc88b120e2e9c3e6460655219573ab82 1650w, https://mintcdn.com/convoy/XhPeZtY53ttiAPxQ/images/portal-event-deliveries.png?w=2500\u0026fit=max\u0026auto=format\u0026n=XhPeZtY53ttiAPxQ\u0026q=85\u0026s=bb8e9515c37b8f0395bcc953b43173c4 2500w`})}),`\n`,_jsx(Heading,{level:`2`,id:`caveats`,children:`Caveats`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Portal Links do not expire, to disable you have to explicitly call the API or disable it through the dashboard.`}),`\n`,_jsx(_components.li,{children:`Portal Links can be created for one or more endpoints.`}),`\n`]})]})}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":"Portal Links","og:title":"Portal Links","og:description":"The portal link serves as a medium to quickly generate portals for users to review and debug events from a publisher","twitter:description":"The portal link serves as a medium to quickly generate portals for users to review and debug events from a publisher","twitter:url":"https://getconvoy.io/docs/product-manual/portal-links","description":null,"href":"/product-manual/portal-links"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Caveats","slug":"caveats","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"convoy","siteName":"Convoy","title":"Portal Links","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-21T21:37:03.145Z","originalFileLocation":"product-manual/portal-links.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=\"Convoy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_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=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Portal Links\">\u003cmeta data-mint-head property=\"og:description\" content=\"The portal link serves as a medium to quickly generate portals for users to review and debug events from a publisher\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Convoy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.getconvoy.io/docs/product-manual/portal-links\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://convoy.mintlify.site/docs/_mintlify/api/og/v2?division=Product+Manual\u0026amp;title=Portal+Links\u0026amp;theme=c3e2637d3c607fb0b7840509\u0026amp;signature=9b3e013c18609a2b94c79c948aba6b409172b991b59d4d8cca1398c233f1b086\">\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=\"Portal Links\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The portal link serves as a medium to quickly generate portals for users to review and debug events from a publisher\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://convoy.mintlify.site/docs/_mintlify/api/og/v2?division=Product+Manual\u0026amp;title=Portal+Links\u0026amp;theme=c3e2637d3c607fb0b7840509\u0026amp;signature=9b3e013c18609a2b94c79c948aba6b409172b991b59d4d8cca1398c233f1b086\">\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=\"/docs/mintlify-assets/_mintlify/favicons/convoy/kEzgHUgYWKvNq-_s/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Convoy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2780F1\">\u003cmeta data-mint-head name=\"twitter:url\" content=\"https://getconvoy.io/docs/product-manual/portal-links\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.getconvoy.io/docs/product-manual/portal-links\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/product-manual/portal-links.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.getconvoy.io/#organization\",\"name\":\"Convoy\",\"url\":\"https://www.getconvoy.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/convoy/ZDnFuM112cm76jYI/logo/light.svg?fit=max\u0026auto=format\u0026n=ZDnFuM112cm76jYI\u0026q=85\u0026s=3d933080cf301678d7fafe5f50d4ec12\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.getconvoy.io/docs#website\",\"name\":\"Convoy\",\"url\":\"https://www.getconvoy.io/docs\",\"publisher\":{\"@id\":\"https://www.getconvoy.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.getconvoy.io/docs/product-manual/portal-links#webpage\",\"url\":\"https://www.getconvoy.io/docs/product-manual/portal-links\",\"name\":\"Portal Links\",\"dateModified\":\"2026-08-21T21:37:03.145Z\",\"isPartOf\":{\"@id\":\"https://www.getconvoy.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.getconvoy.io/docs/product-manual/portal-links#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.getconvoy.io/docs/product-manual/portal-links#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Product Manual\",\"item\":\"https://www.getconvoy.io/docs/product-manual/organizations-and-projects\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Portal Links\",\"item\":\"https://www.getconvoy.io/docs/product-manual/portal-links\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://www.getconvoy.io/docs/product-manual/portal-links#article\",\"headline\":\"Portal Links\",\"name\":\"Portal Links\",\"url\":\"https://www.getconvoy.io/docs/product-manual/portal-links\",\"mainEntityOfPage\":{\"@id\":\"https://www.getconvoy.io/docs/product-manual/portal-links#webpage\"},\"dateModified\":\"2026-08-21T21:37:03.145Z\",\"publisher\":{\"@id\":\"https://www.getconvoy.io/#organization\"},\"isPartOf\":{\"@id\":\"https://www.getconvoy.io/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Convoy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Convoy","nav":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://convoy-community.slack.com/join/shared_invite/zt-xiuuoj0m-yPp~ylfYMCV9s038QL0IUQ#/shared-invite/email"},{"anchor":"GitHub","icon":"github","href":"https://github.com/frain-dev/convoy"},{"anchor":"Status","icon":"signal","href":"https://status.getconvoy.io"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"Home","pages":[{"title":"Quickstart","mode":"wide","href":"/home/quickstart"},{"title":"Introduction","href":"/home/introduction"}]},{"group":"Guides","pages":[{"title":"Send Your First Webhook Event","sidebarTitle":"Send Event","href":"/guides/sending-webhook-example"},{"title":"Receive Your First Webhook Event","sidebarTitle":"Receive Event","href":"/guides/receiving-webhook-example"},{"title":"Best practices for generating webhook events","sidebarTitle":"Best practices for generating webhook events","href":"/guides/best-practices-for-generating-webhook-events"},{"title":"API-driven onboarding","href":"/guides/api-onboarding"}]},{"group":"Deployment","pages":[{"title":"Architecture","href":"/deployment/architecture"},{"title":"Configuration","href":"/deployment/configuration"},{"title":"PostgreSQL \u0026 PGBouncer","sidebarTitle":"PostgreSQL \u0026 PGBouncer","href":"/deployment/postgres-and-pgbouncer"},{"title":"Redis \u0026 Redis Sentinel","sidebarTitle":"Redis \u0026 Redis Sentinel","href":"/deployment/redis-and-sentinel"},{"group":"Install Convoy","pages":[{"title":"Docker","href":"/deployment/install-convoy/docker"},{"title":"Kubernetes","href":"/deployment/install-convoy/kubernetes"},{"title":"AKS (Azure Kubernetes Service)","href":"/deployment/install-convoy/aks"},{"title":"Troubleshooting","href":"/deployment/install-convoy/troubleshooting"}]}]},{"group":"Product Manual","pages":[{"title":"Organizations and Projects","href":"/product-manual/organizations-and-projects"},{"title":"Role-Based Access Control (RBAC)","href":"/product-manual/rbac"},{"title":"Google Single Sign-On (SSO)","href":"/product-manual/google-sso"},{"title":"Endpoints","href":"/product-manual/endpoints"},{"title":"Endpoint verification and outbound connections","href":"/product-manual/endpoint-verification"},{"title":"Signatures","href":"/product-manual/signatures"},{"title":"Sources","href":"/product-manual/sources"},{"title":"Subscriptions","href":"/product-manual/subscriptions"},{"title":"Events and Event Deliveries","description":null,"href":"/product-manual/events-and-event-deliveries"},{"title":"Portal Links","href":"/product-manual/portal-links"},{"title":"Meta Events","description":null,"href":"/product-manual/meta-events"},{"title":"Idempotency","href":"/product-manual/idempotency"},{"title":"Webhooks Documentation","href":"/product-manual/webhooks-documentation"},{"group":"Forward Proxies","pages":[{"title":null,"href":"/product-manual/forward-proxies/nginx"},{"title":null,"href":"/product-manual/forward-proxies/smokescreen"}]},{"group":"Message Brokers","pages":[{"title":"Apache Kafka","href":"/product-manual/message-brokers/kafka"},{"title":"Amazon SQS","href":"/product-manual/message-brokers/sqs"},{"title":"Google PubSub","href":"/product-manual/message-brokers/pub-sub"},{"title":"RabbitMQ","href":"/product-manual/message-brokers/rabbitmq"}]},{"title":"Rate Limits","href":"/product-manual/rate-limits"},{"title":"Filters","href":"/product-manual/filters"},{"title":"Functions","href":"/product-manual/functions"},{"title":"Metrics","href":"/product-manual/metrics"},{"title":"Read Replicas","href":"/product-manual/read-replicas"},{"title":"Circuit Breaker","href":"/product-manual/circuit-breaker"},{"title":"Postgres Queue","href":"/product-manual/postgres-queue"},{"title":"Retention Policy","href":"/product-manual/retention-policy"},{"title":"Custom Certificate Authority","href":"/product-manual/custom-certificate-authority"}]},{"group":"Command Line","pages":[{"title":"CLI","sidebarTitle":"Convoy","href":"/cli-file/convoy"},{"title":"Convoy CLI","href":"/cli-file/convoy-cli"}]},{"group":"SDK","pages":[{"title":"SDK","sidebarTitle":"Overview","href":"/sdk/sdk"}]},{"group":"Cloud","pages":[{"title":"Convoy Cloud Upgrade Policy","sidebarTitle":"Cloud Upgrade Policy","href":"/cloud/cloud-upgrade-policy"},{"title":"Convoy Cloud Subscription and Access Policy","sidebarTitle":"Convoy Cloud Subscription and Access Policy","href":"/cloud/cloud-subscription-policy"}]},{"group":"Legal","pages":[{"title":"Support Policy","href":"/legal/support-policy"},{"title":"Software License Agreement","href":"/legal/software-license-agreement"}]},{"group":"Business \u0026 Enterprise","pages":[{"title":"Licensing","href":"/business-and-enterprise/licensing"},{"title":"Paid Features","href":"/business-and-enterprise/paid-features"},{"title":"Single Sign-On (SAML)","href":"/business-and-enterprise/single-sign-on"}]},{"group":"Glossary","pages":[{"title":"Glossary","href":"/glossary/overview"},{"title":"Projects","href":"/glossary/projects"},{"title":"Endpoints","href":"/glossary/endpoints"},{"title":"Events","href":"/glossary/events"},{"title":"Event delivery","href":"/glossary/event-delivery"},{"title":"Event Types","href":"/glossary/event-types"},{"title":"Delivery Attempts","href":"/glossary/delivery-attempts"},{"title":"Dead Endpoints","href":"/glossary/dead-endpoints"},{"title":"Secrets","href":"/glossary/secrets"},{"title":"Hash Functions","href":"/glossary/hash-functions"},{"title":"Replay Attacks","href":"/glossary/replay-attacks"},{"title":"Rate Limiting Endpoints","href":"/glossary/rate-limiting-endpoints"},{"title":"Retry Schedule","href":"/glossary/retry-schedule"}]},{"group":"Resources","pages":[{"title":"Telemetry","href":"/resources/telemetry"},{"title":"Feature Flags","href":"/resources/feature-flags"}]},{"group":"FAQ","pages":[{"title":"FAQ","sidebarTitle":"Overview","href":"/faq/faq"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/welcome"}]},{"tab":"Webhook Guides","pages":[{"title":"Webhook Guides","href":"/webhook-guides/webhook-retries"}]}]},"basePath":"","title":"Portal Links","buildId":"dpl_6dVqRXFR2Go5vF5RLvAdHuv189oT","deploymentId":"dpl_6dVqRXFR2Go5vF5RLvAdHuv189oT","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-9l8IeNTQ.js","DynamicMarkdown-BBht_uEs.js","zoom-image-lightbox-CPu1dUmH.js","lightbox-handle-r17bVUz3.js"]}