PartnerPage for Salesforce is an unlocked package that adds three things to your Salesforce org: the embedded listing editor component, the native listing component and a Flow template that creates and updates listings from partner Accounts. This guide installs the package and connects it to your directory; the feature guides take over from there: Embed the listing editor in your partner portal, Native Salesforce listing component and Sync Salesforce records to PartnerPage listings with a Flow.
Before you start
A Generic Directory on PartnerPage with the embedded editor switched on by PartnerPage support. The Vendor Dashboard shows an "Embed the listing editor" card under Directory › Integrations once it is on, and the mint request on that card carries your directory id.
Your organization API key (Vendor Dashboard › Developers). It goes into Salesforce once, in step 2, and never into a browser.
A Salesforce org with an Experience Cloud site for partners, and a system administrator to run the steps. Install in a sandbox first if you have one.
Step 1: install the package
Open the install link while signed in to the org you are installing into:
For a sandbox, replace login.salesforce.com with test.salesforce.com in the address. Choose Install for Admins Only: portal users get access through the permission sets in step 4. If Salesforce asks you to approve third-party access to api.partnerpage.io, approve it. The install takes a minute or two and Salesforce emails you when it is done.
Step 2: put the API key on the credential
Setup › Named Credentials › External Credentials › PartnerPage › principal PartnerPage_Principal › Edit › Authentication Parameters › add a parameter named exactly ApiKey with your organization API key as the value. Salesforce injects the key into the Authorization header at call time; the package's code never reads it, and it is never sent to the browser. A missing or wrong key shows up later as a Named Credential error or an HTTP 403 from PartnerPage.
Step 3: point the package at your directory
Setup › Custom Metadata Types › PartnerPage Setting › Manage Records › Default › Edit:
Field | Value |
Directory Id | Your directory id (required). |
External ID Field |
|
Dashboard Origin |
|
Step 4: assign the permission sets
PartnerPage Partner User to every portal user who should see the components (through their profile or a permission set group). It grants the component controllers and the credential principal.
PartnerPage Integration User to every user and integration that edits partner Accounts, including data loaders and integration users. The Flow syncs as the user who saved the Account, and their callout is refused without it.
Step 5: allocate Platform Cache (native component)
Setup › Platform Cache › PartnerPage › Edit › allocate 1 MB of org cache. The partition installs with 0 MB so the install never fails on an org without capacity. The native component works without it, but then every page load and every save mints and exchanges a new session, which is slower and adds API traffic. The embedded editor does not need it.
Step 6: add the components to your site
Experience Builder › Components › drag PartnerPage Listing Editor (embedded) or PartnerPage Listing (native) onto a page that only signed-in partner users can reach.
Set Card title if you want something other than "Your listing".
Publish the site. The package ships a CSP Trusted Site for
https://directory.partnerpage.io, so the embedded editor is allowed to load; if you changed Dashboard Origin, add a trusted site for that origin (Setup › CSP Trusted Sites).
Check it works
Sign in to the portal as a partner user whose Account Id (or External ID field) equals the External ID of a listing in your directory. The component shows that listing. "No listing matches your account" means no listing carries that External ID yet: set it on the listing (Vendor Dashboard › the listing › External ID) or let the Flow create the listing, see the Flow guide.
Updating
Install the new version from the link PartnerPage sends you, the same way as step 1. Your API key, settings, permission set assignments and cache allocation are kept.
If something is off
What you see | What to check |
A Named Credential error, or "You do not have permission" (HTTP 403) | Step 2: the parameter must be named |
"PartnerPage is not configured" | Step 3: Directory Id is empty. |
Portal users do not see the component, or see an error about access | Step 4: PartnerPage Partner User is missing on their profile or permission set group. |
"The External ID field is editable by portal users" | Step 3: make the field read-only for portal profiles, or use the Account Id. |
The native component is slow | Step 5: the cache partition has no allocation. |
Account edits never reach PartnerPage | The Flow is still inactive, or the user who saved the Account lacks PartnerPage Integration User. See the Flow guide. |