Skip to main content

Integration Mini-sites

When your org integrates with external systems (DocuSign, SAP, Stripe, your in-house middleware, …), aprity documentation includes an Integrations section with one mini-site per external system. Each mini-site explains, in business language, what that integration does, when it fires, and which Salesforce components are involved.

This section answers the kind of question a new team member or an auditor asks : "How does our org talk to DocuSign ? What triggers a contract send ? Which Apex class handles the signature event ?"

What you'll see​

Each integration mini-site is anchored on the Apex service class that drives the integration (e.g. DocuSignService, SAPCustomerSyncService) and contains :

  1. System summary -- what the external system is and what aprity has observed of the integration with it (outbound calls, inbound endpoints, events).
  2. Inbound endpoints -- REST or Apex web-service endpoints exposed by your org that the external system calls into. Includes URL pattern, authentication mode, and which Salesforce records get updated.
  3. Outbound calls -- every Apex method that invokes the external system (callouts to Named Credentials, HTTP requests to declared external services). Includes the trigger that fires them (a user action, a scheduled job, a record update).
  4. Events -- Platform Events your org publishes for this system to subscribe to, or events your org subscribes to from this system.
  5. Linked Named Credentials and Connected Apps -- the Salesforce configuration objects that authorize and route the integration traffic.
  6. Linked business rules -- the validation rules, automations, or approval processes that fire as part of the integration flow.

How systems are discovered​

aprity does not rely on the names you've used in Salesforce setup to invent integrations. The Integration Map is the result of a deterministic scan of your org's :

  • Apex source code -- every callout, REST endpoint declaration, and event-publication / subscription statement is parsed and indexed.
  • Named Credentials, External Services, and Connected Apps -- the formal Salesforce configuration of "who can talk to whom".
  • Platform Events -- declared publishers and subscribers.
  • Process and validation metadata -- automations that fire as part of an integration flow.

aprity then groups all of those signals by the external system they share -- typically driven by the Apex service class that owns the flow. A mini-site only appears when there is enough concrete evidence in your code that the integration exists and is active.

Configurations that are declared in your org but never used in code (a Named Credential with no callsite, a Connected App with no observed flow) are listed in a separate Unused metadata appendix at the end of the Integration Map, so you know they exist without inflating the active integration count.

Plan availability​

Integration Mini-sites are part of the Integration Inventory feature, which is included on every plan:

  • Trial -- included.
  • Documentation -- included.
  • Intelligence -- included.

See Plan Comparison for the full feature matrix.

Where to find them​

  • Customer Portal : the Integrations entry in the sidebar. See Customer Portal.
  • StorySite export : each integration mini-site becomes an EPIC in the backlog ("Integration : DocuSign", "Integration : SAP") so a migration project can plan the integration work alongside the in-org work. See StorySite — Backlog export.
  • Help Agent / Story Agent : the agents are aware of integration mini-sites and will cite the relevant system when answering a question about an external flow.

How to use them​

A mini-site is the right starting point when you need to :

  • Onboard a new integration developer -- one mini-site per system is the integration playbook.
  • Plan a migration or system replacement -- "We're switching from DocuSign to Adobe Sign : what do we need to change ?" -- the DocuSign mini-site is the answer.
  • Audit external data flows -- demonstrate to a security or compliance reviewer that your org's outbound calls go through Named Credentials (not hardcoded URLs) and that inbound endpoints are properly authenticated.
  • Diagnose an integration incident -- "DocuSign is not receiving events any more" -- find the mini-site, follow the outbound callsites, identify the broken automation.

Limitations​

  • An integration mini-site requires at least one observable Apex callsite, REST endpoint, or event publish / subscribe. Declared metadata without code evidence stays in the appendix.
  • Mini-sites are organized by Apex service class. If your org uses a different convention (e.g. one Named Credential per logical system with no dedicated service class), the grouping might split or merge unexpectedly. You can submit feedback on a mini-site to suggest a regrouping.
  • aprity does not call the external system to validate the integration is healthy -- it reflects what your org is configured to do, not whether the external system is currently responding.

For anything else, contact support@aprity.ai.