---
updatedAt: 2026-05-01T14:06:39.000Z
agentTools:
  siteIndex: https://docs.recurly.com/llms.txt
  projectIndex: https://docs.recurly.com/recurly-engage/llms.txt
---

# Redirects user to Pulse (Redfast Frontend)

Redirects a user to pulse.redfast.com, optionally to a specified path, and attaches the session token. If no valid session, the user will be sent to the login page.


# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Redfast Session Redirect API",
    "version": "1.0",
    "license": {
      "name": "MIT",
      "url": "https://opensource.org/licenses/MIT"
    }
  },
  "servers": [
    {
      "url": "https://partner.redfast.com"
    }
  ],
  "paths": {
    "/v1/session/redirect": {
      "get": {
        "summary": "Redirects user to Pulse (Redfast Frontend)",
        "description": "Redirects a user to pulse.redfast.com, optionally to a specified path, and attaches the session token. If no valid session, the user will be sent to the login page.\n",
        "tags": [
          "Redirect"
        ],
        "parameters": [
          {
            "name": "session_token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Redfast session token that authenticates the user for frontend access.\n"
          },
          {
            "name": "redirect_url",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Optional relative path (e.g., `/welcome`) to redirect to after login.  Defaults to root if not provided.\n"
          }
        ],
        "responses": {
          "302": {
            "description": "Redirects the user to Pulse frontend",
            "headers": {
              "Location": {
                "description": "Final URL to redirect the browser",
                "schema": {
                  "type": "string",
                  "example": "https://pulse.redfast.com/welcome?session_token=eyJhbGciOi..."
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized - Invalid session token or redirect target",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "example": false
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "unauthorized"
                      ],
                      "example": "unauthorized"
                    },
                    "message": {
                      "type": "string",
                      "example": "Invalid or expired session token"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```

# Sibling pages

* [Get an existing Redfast tenant](https://docs.recurly.com/recurly-engage/reference/get_v1-tenants-external-tenant-id.md)
* [Create a new Redfast tenant](https://docs.recurly.com/recurly-engage/reference/post_v1-tenants.md)
* [Update a Redfast tenant](https://docs.recurly.com/recurly-engage/reference/patch_v1-tenants.md)
* [Provision user and create session](https://docs.recurly.com/recurly-engage/reference/post_v1-jwt-session.md)