Platform Overview

Welcome to Pindown.ai - your personal canvas for live data. Transform your automation workflows into beautiful, real-time dashboards that update instantly.

What is Pindown.ai?

Pindown.ai is a visual dashboard platform that connects to your automation workflows (Zapier, Make, n8n, or custom scripts) and displays your data in real-time. Think of it as a living, breathing pinboard where each “pin” represents a piece of your data.

Key Concepts

🔖 Pins
Individual data visualizations that display your information (stats, charts, tables, alerts, markdown content, etc.). Each pin has a pin_type (e.g., stat-cards, line-chart, markdown) and a pin_config that defines its content. Pins update in real-time when you push new data via API.

📄 Pages
Collections of pins organized into structured documents. Pages are perfect for reports, documentation, or any content that needs a linear flow. Each page can contain multiple pins arranged in sequence.

📋 Pinboards
Collections of pins organized into visual dashboards. Drag and drop pins to arrange them however you like. Perfect for dashboards and visual analytics.

🔧 Builder
Create Pages, Pinboards, Showcases, and Pins from your own workflow data, documents, and other sources. Transform your data into visual content automatically.

🤝 Sharing
Share your pins, pages, and pinboards publicly or invite specific collaborators with granular permissions (viewer, editor).

Getting Started

Step 1: Sign Up & Create Your First Page

1. Sign up for a free account
2. Navigate to Pages
3. Click “Create Page”
4. Give it a name (e.g., “My First Report”)

Step 2: Add Your First Pin

There are two ways to add pins to your page:

Option A: Create Manually (UI)

1. Open your page
2. Click “Add Pin”
3. Choose a pin type (Stat Card, Chart, Markdown, etc.)
4. Fill in the configuration
5. Save! The pin appears on your page

Option B: Create via API (Recommended for Automation)

import { PindownClient } from '@pindownai/client-js'
 
const client = new PindownClient({
  apiKey: process.env.PINDOWN_API_KEY
})
 
const pin = await client.pins.create({
  metadata: {
    title: 'Sales Dashboard'
  }
})
 
console.log(`Pin created: ${pin.id}`)

curl -X POST https://api.pindown.ai/v1/pins \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {
      "title": "Sales Dashboard"
    }
  }'

const response = await fetch('https://api.pindown.ai/v1/pins', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.PINDOWN_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    metadata: {
      title: 'Sales Dashboard'
    }
  })
})
 
const result = await response.json()
console.log(`Pin created: ${result.data.id}`)

Step 3: Get Your API Key

To connect your automation workflows:

1. Go to Dashboard → API Keys
2. Click “Generate New API Key”
3. Give it a name (e.g., “Zapier Integration”)
4. Copy your API key (shown only once!)

Step 4: Connect Your Automation

Zapier Example

1. Create a new Zap
2. Add your trigger (e.g., “New Sale in Stripe”)
3. Add action: “Webhooks by Zapier”
4. Choose “PUT” request
5. URL: https://api.pindown.ai/v1/pins/YOUR_PIN_ID
6. Headers: Authorization: Bearer YOUR_API_KEY
7. Body: Your pin content (JSON)

Make (Integromat) Example

1. Create a new scenario
2. Add your trigger module
3. Add “HTTP” module → “Make a Request”
4. Method: PUT
5. URL: https://api.pindown.ai/v1/pins/YOUR_PIN_ID
6. Headers: Add Authorization: Bearer YOUR_API_KEY
7. Body: Map your data to pin content

n8n Example

1. Create a new workflow
2. Add your trigger node
3. Add “HTTP Request” node
4. Method: PUT
5. URL: https://api.pindown.ai/v1/pins/YOUR_PIN_ID
6. Authentication: “Header Auth”
   • Name: Authorization
   • Value: Bearer YOUR_API_KEY
7. Body: Your pin content (JSON)

Pin Types Overview

Pindown.ai supports 11+ pin types to visualize your data. Each pin uses a unified structure with pin_type and pin_config:

All pins use the same unified structure:

• pin_type: The type of visualization (e.g., stat-cards, markdown)
• pin_config: The configuration object specific to that pin type
• pin_layout: Optional layout size (e.g., 1x1, 2x2, 4x4)

Sharing & Collaboration

Share Publicly

1. Open your pinboard
2. Click “Share” button
3. Toggle “Make public”
4. Copy the share link
5. Anyone with the link can view (no login required!)

Invite Collaborators

1. Click “Share” button
2. Enter email address
3. Choose role:
   • Viewer: Can only view
   • Editor: Can edit pins and layout
4. Send invite
5. They’ll receive an email with access

Permission Levels

Best Practices

1. Use Descriptive Names

Give your pins and pinboards clear, descriptive names:

• ✅ “Monthly Sales Dashboard”
• ❌ “Dashboard 1”

2. Organize with Tags

Tag your pins for easy filtering:

{
  "metadata": {
    "tags": ["sales", "monthly", "revenue"]
  }
}

3. Keep Pinboards Focused

Don’t overcrowd a single pinboard. Instead:

• Create separate pinboards for different topics
• Link related pinboards together
• Use consistent layouts within each board

4. Update Regularly

Set up automation to push updates frequently:

• Real-time: Every few seconds for critical metrics
• Scheduled: Hourly/daily for reports
• Event-based: On specific triggers (new sale, error, etc.)

Need Help?

• 💬 Discord: Join our community 
• 📖 API Docs: Complete API Reference
• 🔑 API Keys: Manage your API keys

Next Steps

• Creating a Page - Step-by-step guide to create your first page
• Create a Pinboard - Build visual dashboards
• Builder - Create content from your data
• Sharing - Collaborate with your team
• API Reference - Automate everything