Agave · JSON Structure

Unified Api Link Session Request Structure

Request payload for creating an Agave Link session.

Type: object Properties: 2 Required: 1
AccountingConstructionIntegration

LinkSessionRequest is a JSON Structure definition published by Agave, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

reference_id redirect_url

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/agave/refs/heads/main/json-structure/unified-api-link-session-request-structure.json",
  "name": "LinkSessionRequest",
  "description": "Request payload for creating an Agave Link session.",
  "type": "object",
  "properties": {
    "reference_id": {
      "type": "string",
      "description": "Unique identifier for the user or entity linking their account.",
      "example": "user-789-procore"
    },
    "redirect_url": {
      "type": "string",
      "description": "URL to redirect the user to after completing the link flow.",
      "example": "https://myapp.com/integration/callback"
    }
  },
  "required": [
    "reference_id"
  ]
}