HOhookdeck
Tenants

Get Portal Redirect URL

Changed on

Returns a redirect URL containing a JWT to authenticate the user with the portal. Requires Admin API Key.

get/tenants/{tenant_id}/portal

Request

  • Base URL
    https://api.outpost.hookdeck.com/2025-07-01
  • Auth
    HTTP bearer

Query parameters

theme'light' | 'dark'

Optional theme preference for the portal.

Response

Portal redirect URL.

redirect_urlstring url

Redirect URL containing a JWT to authenticate the user with the portal.

tenant_idstring

The ID of the tenant associated with this portal session.

Example response

{
  "redirect_url": "https://webhooks.acme.com/?token=JWT_TOKEN&tenant_id=tenant_123",
  "tenant_id": "tenant_123"
}

Changes

  • 245bc66dbe5aRevision changes
    • info

      added the non-success response with the status

  • c36d2dacd201Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status