Agave · Schema

LinkSessionRequest

Request payload for creating an Agave Link session.

AccountingConstructionIntegration

Properties

Name Type Description
reference_id string Unique identifier for the user or entity linking their account.
redirect_url string URL to redirect the user to after completing the link flow.
View JSON Schema on GitHub

JSON Schema

unified-api-link-session-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/agave/refs/heads/main/json-schema/unified-api-link-session-request-schema.json",
  "title": "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"
  ]
}