Developer Portal

The Developer Portal is an embeddable UI that lets your customers configure their own webhook endpoints without you building a custom integration page.

When to Use It

If you're building a SaaS platform and want to offer webhooks to your customers, the Developer Portal saves you from building:

• An endpoint management UI
• Webhook testing tools
• Event type subscription management

Instead, you embed Nahook's portal and your customers manage their own endpoints directly.

How It Works

Your SaaS App                  Nahook
    │                            │
    │ 1. Create Application      │
    │    (Management API)        │
    │ ──────────────────────────>│
    │                            │
    │ 2. Create Portal Session   │
    │    for customer            │
    │ ──────────────────────────>│
    │                            │
    │    { portalUrl, code }     │
    │ <──────────────────────────│
    │                            │
    │ 3. Redirect customer       │
    │    to portalUrl            │
    │                            │
    │         Customer ──────────│──> Portal UI
    │                            │    - Create endpoints
    │                            │    - Subscribe to events
    │                            │    - Test deliveries

Key Concepts

• Application: Represents one of your customers in Nahook. Each application gets its own isolated set of endpoints.
• Portal Session: A time-limited session that grants your customer access to manage their application's endpoints.
• Session Code: A one-time code used to exchange for a portal session token. Expires in 5 minutes.
• Permissions: Granular scopes (endpoints:read, endpoints:write, endpoints:delete, etc.) assigned via roles (admin, editor, viewer) to control what each customer can do.

Metadata Tracking

When creating a portal session, you can attach metadata that gets automatically added to any endpoints the customer creates:

{
  "metadata": {
    "customerId": "cust_123",
    "plan": "pro"
  }
}

This lets you track which customer created each endpoint without additional bookkeeping.

Next Steps