xR2 n8n Community Node

A community node for n8n that integrates with the xR2 API to fetch prompts and track analytics events in your workflows.

Features

• Get Prompt: Fetch prompt templates from xR2 by slug

  • Returns system, user, and assistant prompt components
  • Support for version and status filtering
  • Variables metadata with type information
  • Automatic trace_id generation for analytics
  • A/B testing support

• Track Event: Send analytics events with trace_id for monitoring and debugging

  • Track prompt usage across workflows
  • Custom event metadata payloads
  • Full integration with xR2 analytics dashboard

Installation

In n8n GUI

1. Go to Settings → Community Nodes
2. Click Install
3. Enter n8n-nodes-xr2
4. Click Install

Manual Installation

npm install n8n-nodes-xr2

Setup

1. Get your xR2 API Key

1. Log in to your xR2 account
2. Navigate to API Keys section
3. Create a new Product API key
4. Copy the key (starts with xr2_prod_...)

2. Configure Credentials in n8n

1. In n8n, go to Settings → Credentials
2. Click New → search for "xR2 API"
3. Paste your API key
4. Click Save

Usage

Get Prompt

Fetches a prompt from xR2 by slug.

Parameters:

• Slug (required): The unique identifier for your prompt

• Version Number (optional): Specific version number to fetch (0 = latest deployed version). Use this when you need a particular version of the prompt.

• Status (optional): Filter by version status. Options:

  • Any (Default): Get the latest deployed version regardless of status (recommended)
  • Production: Only production versions
  • Testing: Only testing versions
  • Draft: Only draft versions
  • Inactive: Only inactive versions
  • Deprecated: Only deprecated versions

  ⚠️ Note: If you select a specific status and no version with that status exists, you'll get a 404 error. Leave as "Any" unless you specifically need a version with a particular status.

  Source Name: Auto-filled as n8n_sdk (not editable).

Output:

{
  "slug": "my-prompt",
  "source_name": "n8n_sdk",
  "version_number": 2,
  "status": "production",
  "system_prompt": "You are a helpful assistant",
  "user_prompt": "Help me with {{task}}",
  "assistant_prompt": "",
  "variables": [
    {
      "name": "task",
      "type": "string",
      "default": "",
      "required": true
    }
  ],
  "deployed_at": "2025-11-28T14:46:01.812013Z",
  "created_at": "2025-11-16T08:37:48.891068Z",
  "updated_at": "2025-11-28T14:46:01.767124Z",
  "trace_id": "evt_550e8400_1234567890_abcd1234",
  "ab_test_id": null,
  "ab_test_name": null,
  "ab_test_variant": null
}

Track Event

Sends an analytics event to xR2.

Parameters:

• Trace ID (required): UUID from Get Prompt response or custom identifier
• Event Name (required): Name of the event (e.g., "sign_up", "purchase_completed")
• Source Name: Auto-filled as n8n_sdk (no need to set manually)
• User ID (optional)
• Session ID (optional)
• Value/Currency (optional): numeric value with currency code
• Metadata (optional): JSON object with additional event data

Output:

{
  "success": true,
  "event_id": "evt_123abc"
}

Example Workflows

Basic: Check API Key, Get Prompt, Track Event

[Manual Trigger] → [xR2: Check API Key] → [xR2: Get Prompt] → [xR2: Track Event]

1. xR2 Node (Check API Key):
   • Resource: API Key
   • Operation: Check
2. xR2 Node (Get Prompt):
   • Slug: welcome
3. xR2 Node (Track Event):
   • Trace ID: {{ $('xR2').item.json.trace_id }}
   • Event Name: sign_up
   • User ID: user_123
   • Metadata: {}

Revenue Tracking: Purchase Event

[Manual Trigger] → [xR2: Get Prompt] → [xR2: Track Event]

1. xR2 Node (Get Prompt):
   • Slug: welcome
2. xR2 Node (Track Event):
   • Trace ID: {{ $('xR2').item.json.trace_id }}
   • Event Name: purchase_completed
   • User ID: user_123
   • Value: 99.99
   • Currency: USD
   • Metadata: {"order_id": "order_67890", "product_id": "prod_456"}

With Error Handling

[Schedule Trigger]
  → [xR2: Get Prompt]
  → [Switch: Check if error]
      ├─ Success → [Process Data]
      └─ Error → [xR2: Track Event] (log error)

API Reference

Base URL

All requests go to: https://xr2.uk/api/v1

Authentication

Bearer token authentication using your Product API key.

Endpoints Used

• POST /api/v1/get-prompt - Get Prompt operation
• POST /api/v1/events - Track Event operation

Troubleshooting

🔐 Authentication Failed

Error message:

Authentication failed. Please check your API key in credentials.

Solutions:

• ✓ Verify your API key is correct in n8n credentials
• ✓ Ensure the API key starts with xr2_prod_
• ✓ Check that the API key is active in your xR2 account
• ✓ Make sure you're using a Product API key (not a Management API key)

❌ Prompt Not Found

Error message:

Resource not found. Please verify:
- The prompt slug is correct (no typos)
- The prompt exists in your xR2 dashboard
- The prompt has at least one published version
- You have access to this prompt in your workspace

Solutions:

• ✓ Check that the slug exists in your xR2 account at https://xr2.uk/prompts
• ✓ Verify the prompt has a published version (production, testing, etc.)
• ✓ If using Status filter, ensure a version with that status exists
• ✓ Leave Status as "Any (Default)" to get the latest deployed version

🔧 Node Not Appearing in n8n

Solutions:

• ✓ Restart n8n after installation
• ✓ Clear browser cache (Cmd+Shift+R or Ctrl+Shift+R)
• ✓ Check n8n logs for errors: n8n start --verbose
• ✓ Verify the package is in ~/.n8n/custom/node_modules/n8n-nodes-xr2/

📊 Understanding Response Fields

The API returns separate fields for different prompt components:

• system_prompt: The system/role instruction for the AI
• user_prompt: The user message template (may contain variables like {{task}})
• assistant_prompt: Optional assistant response prefix
• variables: Array of variable definitions with type and requirements
• trace_id: Unique identifier for tracking this prompt request

Development

# Install dependencies
npm install

# Build
npm run build

# Clean build artifacts
npm run clean

License

MIT

Support

For issues with:

• This node: hello@xr2.uk
• xR2 API: hello@xr2.uk
• n8n: Visit n8n community forum