GET /v1/callbacks/variables

Retrieve a complete list of available template variables that can be used in custom callback payload templates and Discord message templates. This endpoint returns detailed information about each variable including its name, description, example value, data type, usage context, and any plan requirements. Use this endpoint to discover available variables, understand their data types and formats, check plan requirements, or build dynamic template editors that help users create custom payloads. The response includes variables available for all plans as well as premium variables that require Growth+ or Pro+ plans, allowing you to filter options based on the user's current subscription tier.

Request

http

GET https://api.votepipe.com/v1/callbacks/variables
Authorization: Bearer mr_live_your_api_key_here

Response (200 OK)

json

{
  "data": {
    "variables": [
      {
        "name": "voter_name",
        "description": "The username of the voter",
        "example": "PlayerOne",
        "type": "string",
        "context": "both",
        "required_plan": null
      },
      {
        "name": "provider_key",
        "description": "The provider key (slug)",
        "example": "hytale-servers-pro",
        "type": "string",
        "context": "both",
        "required_plan": null
      },
      {
        "name": "provider_name",
        "description": "The provider display name",
        "example": "Hytale-Servers.pro",
        "type": "string",
        "context": "both",
        "required_plan": null
      },
      {
        "name": "provider_server_url",
        "description": "Provider server URL or vote URL (if configured)",
        "example": "https://www.hytale-servers.pro/servers/myserver",
        "type": "string",
        "context": "both",
        "required_plan": null
      },
      {
        "name": "vote_id",
        "description": "The prefixed vote identifier",
        "example": "vt_550e8400-e29b-41d4-a716-446655440000",
        "type": "string",
        "context": "both",
        "required_plan": null
      },
      {
        "name": "vote_public_id",
        "description": "The public vote identifier (UUID)",
        "example": "550e8400-e29b-41d4-a716-446655440000",
        "type": "uuid",
        "context": "both",
        "required_plan": null
      },
      {
        "name": "received_at",
        "description": "ISO timestamp when vote was received",
        "example": "2026-01-09T14:30:00.000Z",
        "type": "timestamp",
        "context": "both",
        "required_plan": null
      },
      {
        "name": "voter_total_votes",
        "description": "Total votes from this user (all time)",
        "example": "42",
        "type": "number",
        "context": "both",
        "required_plan": "growth"
      },
      {
        "name": "voter_global_rank",
        "description": "Global ranking position of the voter",
        "example": "15",
        "type": "number",
        "context": "both",
        "required_plan": "pro"
      },
      {
        "name": "raw_payload",
        "description": "Access fields from original webhook payload",
        "example": "{raw_payload.server_slug}",
        "type": "object",
        "context": "both",
        "required_plan": null,
        "supports_nested": true
      }
    ]
  }
}