Skip to main content

​
Overview

Developer portals (integration pages) enable partners to manage their entire integration lifecycle without engineering involvement. Partners can onboard, browse your event catalog, generate credentials, manage subscriptions, and view analytics—all through a branded portal embedded in your platform.

​
Steps

​
1. Navigate to Integrations

Open the EnSync Dashboard and go to the Integrations section.

​
2. Create New Developer Portal

Click “Create Developer Portal” and provide:
  • Name: Descriptive identifier (e.g., “Payment Partners Portal”)
  • Description: What this integration is for

​
3. Select Events to Expose

Choose which events partners can subscribe to:
  • Browse your event catalog
  • Select events relevant to this partner type
  • Partners will see these events with their schemas and descriptions

​
4. Configure Callback Events

Optionally, allow partners to publish events back to you:
  • Select which event types partners can publish
  • Enables bidirectional communication

​
5. Customize Branding

Personalize the developer portal:
  • Upload your logo
  • Set brand colors
  • Add custom welcome message

​
6. Generate Portal URL

The dashboard generates a unique URL: 
https://ensync.cloud/integrate/{integration-id}
Share this URL with partners or embed it directly in your platform.

​
What Partners Can Do

Once connected, partners use the developer portal to:
  • View Metrics: See event delivery rates, latency, and error rates
  • Manage Subscriptions: Subscribe to new events or unsubscribe from existing ones
  • Update Permissions: Request access to additional events
  • Monitor Integration: Track their integration health and performance

​
Use Cases

Payment Partners: Expose order/created, order/updated events; allow payment/completed callbacks Shipping Providers: Expose order/shipped events; allow shipment/updated callbacks Analytics Partners: Expose all events; no callback events needed

​
Next Steps

  • Share the portal URL with partners or embed it in your platform
  • Monitor partner connections in the Dashboard
  • View integration analytics to track usage
  • Partners can return to the portal anytime to manage their integration