Links And Permalinks

What It Is

Jetstack supports two related public-entry mechanisms:

  • permanent links
  • tenant routes

These are tenant-managed definitions that can point to URLs, public modules, public canvases, webhooks, or route payloads.

Why It Matters

They allow a tenant to expose controlled entry points without modifying core application code.

A permanent link can represent:

  • a direct URL
  • a public module
  • a public canvas
  • a webhook
  • a route-style destination

Permanent links are useful when you need a stable reference that can be shared or embedded.

Tenant Routes

Tenant routes add:

  • a human-managed title
  • a route mask
  • a route type
  • route payload

They are useful when public entry should look like a deliberate tenant endpoint rather than a random generated link name.

Public Modules And Canvases

Links and routes often depend on:

  • modules marked public
  • public canvas routes

That means link design should be coordinated with module and canvas exposure decisions.

Webhook Integration

Webhook targets can also be modeled through links and routes. This makes the link system part of the integration story, not just a navigation convenience.

Best Practices

  • Expose only deliberately public experiences.
  • Keep route payloads simple and documented.
  • Treat webhook-related links as integration assets, not casual shortcuts.
  • Review permanent links during rollout and governance reviews.