Podium Ci Integration

Overview

Implementation patterns for Podium ci integration using the REST API with OAuth2 authentication.

Prerequisites

• Completed podium-install-auth setup
• Valid OAuth2 access token

Instructions

Step 1: API Call Pattern

import axios from 'axios';

const podium = axios.create({
  baseURL: 'https://api.podium.com/v4',
  headers: { 'Authorization': `Bearer ${process.env.PODIUM_ACCESS_TOKEN}` },
});

const { data } = await podium.get('/locations');
console.log(`Locations: ${data.data.length}`);

Output

• Podium API integration for ci integration
• OAuth2 authenticated requests
• Error handling and retry logic

Error Handling

Resources

• Podium Developer Portal
• Podium API Docs

Next Steps

See related Podium skills for more workflows.

Podium Common Errors

Overview

Implementation patterns for Podium common errors using the REST API with OAuth2 authentication.

Prerequisites

• Completed podium-install-auth setup
• Valid OAuth2 access token

Instructions

Step 1: API Call Pattern

import axios from 'axios';

const podium = axios.create({
  baseURL: 'https://api.podium.com/v4',
  headers: { 'Authorization': `Bearer ${process.env.PODIUM_ACCESS_TOKEN}` },
});

const { data } = await podium.get('/locations');
console.log(`Locations: ${data.data.length}`);

Output

• Podium API integration for common errors
• OAuth2 authenticated requests
• Error handling and retry logic

Error Handling

Resources

• Podium Developer Portal
• Podium API Docs

Next Steps

See related Podium skills for more workflows.

Podium Core Workflow A

Overview

Build a complete messaging workflow with Podium: send messages, receive inbound messages via webhooks, and manage conversation threads.

Prerequisites

• Completed podium-install-auth with OAuth tokens
• Webhook endpoint accessible via HTTPS

Instructions

Step 1: Set Up Webhook for Inbound Messages

import express from 'express';
const app = express();

app.post('/webhooks/podium', express.json(), async (req, res) => {
  const event = req.body;
  if (event.type === 'message.received') {
    const msg = event.data;
    console.log(`From: ${msg.attributes['contact-phone']}`);
    console.log(`Body: ${msg.attributes.body}`);
    // Auto-reply or route to agent
    await sendReply(msg.attributes['location-uid'], msg.attributes['contact-phone'], 'Thanks for reaching out!');
  }
  res.status(200).json({ received: true });
});

Step 2: Register Webhook with Podium

const { data } = await podium.post('/webhooks', {
  data: {
    attributes: {
      url: 'https://your-app.com/webhooks/podium',
      events: ['message.received', 'message.sent', 'message.failed'],
    },
  },
});
console.log(`Webhook registered: ${data.data.id}`);

Step 3: Send Reply Messages

async function sendReply(locationId: string, phone: string, body: string) {
  const { data } = await podium.post(`/locations/${locationId}/messages`, {
    data: { attributes: { body, 'contact-phone': phone } },
  });
  return data.data.id;
}

Output

• Webhook receiving inbound messages
• Auto-reply capability
• Two-way messaging via Podium

Error Handling

Resources

• Sync Messages
• Webhooks Guide

Next Steps

Reviews and payments: podium-core-workflow-b

Podium Core Workflow B

Overview

Manage reviews and payments with Podium: request reviews from customers, track review status, and create payment invoices.

Prerequisites

• Completed podium-core-workflow-a (messaging)
• Reviews and Payments features enabled in Podium account

Instructions

Step 1: Request a Review

// Send a review request to a customer
const { data } = await podium.post(`/locations/${locationId}/review-invitations`, {
  data: {
    attributes: {
      'contact-phone': '+15551234567',
      'customer-name': 'Jane Doe',
    },
  },
});
console.log(`Review invitation sent: ${data.data.id}`);

Step 2: List Reviews

const { data } = await podium.get(`/locations/${locationId}/reviews`);
for (const review of data.data) {
  console.log(`  ${review.attributes.rating}/5 — ${review.attributes.body}`);
}

Step 3: Create a Payment Invoice

const { data } = await podium.post(`/locations/${locationId}/invoices`, {
  data: {
    attributes: {
      'contact-phone': '+15551234567',
      amount: 5000,  // $50.00 in cents
      description: 'Service invoice #1234',
    },
  },
});
console.log(`Invoice created: ${data.data.id}, amount: $${data.data.attributes.amount / 100}`);

Output

• Review invitations sent to customers
• Review listing with ratings and content
• Payment invoices created and tracked

Error Handling

Resources

• Podium Developer Portal
• Podium API Reference

Next Steps

Handle webhook events: podium-webhooks-events

Podium Cost Tuning

Overview

Implementation patterns for Podium cost tuning using the REST API with OAuth2 authentication.

Prerequisites

• Completed podium-install-auth setup
• Valid OAuth2 access token

Instructions

Step 1: API Call Pattern

import axios from 'axios';

const podium = axios.create({
  baseURL: 'https://api.podium.com/v4',
  headers: { 'Authorization': `Bearer ${process.env.PODIUM_ACCESS_TOKEN}` },
});

const { data } = await podium.get('/locations');
console.log(`Locations: ${data.data.length}`);

Output

• Podium API integration for cost tuning
• OAuth2 authenticated requests
• Error handling and retry logic

Error Handling

Resources

• Podium Developer Portal
• Podium API Docs

Next Steps

See related Podium skills for more workflows.

Podium Debug Bundle

Overview

Implementation patterns for Podium debug bundle using the REST API with OAuth2 authentication.

Prerequisites

• Completed podium-install-auth setup
• Valid OAuth2 access token

Instructions

Step 1: API Call Pattern

import axios from 'axios';

const podium = axios.create({
  baseURL: 'https://api.podium.com/v4',
  headers: { 'Authorization': `Bearer ${process.env.PODIUM_ACCESS_TOKEN}` },
});

const { data } = await podium.get('/locations');
console.log(`Locations: ${data.data.length}`);

Output

• Podium API integration for debug bundle
• OAuth2 authenticated requests
• Error handling and retry logic

Error Handling

Resources

• Podium Developer Portal
• Podium API Docs

Next Steps

See related Podium skills for more workflows.

Podium Deploy Integration

Overview

Implementation patterns for Podium deploy integration using the REST API with OAuth2 authentication.

Prerequisites

• Completed podium-install-auth setup
• Valid OAuth2 access token

Instructions

Step 1: API Call Pattern

import axios from 'axios';

const podium = axios.create({
  baseURL: 'https://api.podium.com/v4',
  headers: { 'Authorization': `Bearer ${process.env.PODIUM_ACCESS_TOKEN}` },
});

const { data } = await podium.get('/locations');
console.log(`Locations: ${data.data.length}`);

Output

• Podium API integration for deploy integration
• OAuth2 authenticated requests
• Error handling and retry logic

Error Handling

Resources

• Podium Developer Portal
• Podium API Docs

Next Steps

See related Podium skills for more workflows.

Podium Hello World

Overview

Send your first Podium message, list contacts, and check location details using the Podium REST API.

Prerequisites

• Completed podium-install-auth setup with valid access token
• A Podium location ID

Instructions

Step 1: List Locations

const { data } = await podium.get('/locations');
for (const loc of data.data) {
  console.log(`Location: ${loc.attributes.name} (ID: ${loc.id})`);
}

Step 2: List Contacts

const locationId = 'loc_xxxxx';
const { data } = await podium.get(`/locations/${locationId}/contacts`);
for (const contact of data.data) {
  console.log(`  ${contact.attributes.name} — ${contact.attributes.phone}`);
}

Step 3: Send a Message

// Messages are sent via the Podium platform to the customer's phone
const { data } = await podium.post(`/locations/${locationId}/messages`, {
  data: {
    attributes: {
      body: 'Hello from our integration! How can we help?',
      'contact-phone': '+15551234567',
    },
  },
});
console.log(`Message sent: ${data.data.id}`);

Output

• Listed locations with IDs
• Retrieved contacts for a location
• Sent a test message via Podium

Error Handling

Resources

• Podium API Reference
• Sync Messages

Next Steps

Build messaging workflow: podium-core-workflow-a

Podium Install Auth

Overview

Set up Podium API authentication using OAuth2 authorization code flow. Podium requires a Developer Account, OAuth application credentials, and user authorization to access location data.

Prerequisites

• Podium Developer Account (apply at developer.podium.com)
• OAuth Application credentials (clientid, clientsecret)
• A Podium location to authorize against

Instructions

Step 1: Register OAuth Application

1. Go to developer.podium.com
2. Create a new OAuth Application
3. Set redirect URI: http://localhost:3000/callback
4. Copy client_id and client_secret
5. Select scopes: messages.read, messages.write, contacts.read, reviews.read

Step 2: Configure Environment

# .env
PODIUM_CLIENT_ID=your_client_id
PODIUM_CLIENT_SECRET=your_client_secret
PODIUM_REDIRECT_URI=http://localhost:3000/callback

Step 3: OAuth2 Authorization Flow

import express from 'express';
import axios from 'axios';

const app = express();

// Step 1: Redirect user to Podium authorization
app.get('/auth', (req, res) => {
  const authUrl = `https://api.podium.com/oauth/authorize?client_id=${process.env.PODIUM_CLIENT_ID}&redirect_uri=${encodeURIComponent(process.env.PODIUM_REDIRECT_URI!)}&response_type=code&scope=messages.read+messages.write`;
  res.redirect(authUrl);
});

// Step 2: Exchange code for access token
app.get('/callback', async (req, res) => {
  const { code } = req.query;
  const { data } = await axios.post('https://api.podium.com/oauth/token', {
    grant_type: 'authorization_code',
    code,
    client_id: process.env.PODIUM_CLIENT_ID,
    client_secret: process.env.PODIUM_CLIENT_SECRET,
    redirect_uri: process.env.PODIUM_REDIRECT_URI,
  });
  console.log(`Access token: ${data.access_token}`);
  console.log(`Refresh token: ${data.refresh_token}`);
  res.json({ status: 'authenticated' });
});

app.listen(3000);

Step 4: Verify Connection

const podium = axios.create({
  baseURL: 'https://api.podium.com/v4',
  headers: { 'Authorization': `Bearer ${accessToken}` },
});

const { data } = await podium.get('/locations');
console.log(`Connected! Locations: ${data.data.length}`);

Output

• OAuth application registered with Podium
• Authorization code flow implemented
• Access and refresh tokens obtained
• API connectivity verified

Error Handling

import axios from 'axios';

const podium = axios.create({
  baseURL: 'https://api.podium.com/v4',
  headers: { 'Authorization': `Bearer ${process.env.PODIUM_ACCESS_TOKEN}` },
});

const { data } = await podium.get('/locations');
console.log(`Locations: ${data.data.length}`);

import axios from 'axios';

const podium = axios.create({
  baseURL: 'https://api.podium.com/v4',
  headers: { 'Authorization': `Bearer ${process.env.PODIUM_ACCESS_TOKEN}` },
});

const { data } = await podium.get('/locations');
console.log(`Locations: ${data.data.length}`);

import axios from 'axios';

const podium = axios.create({
  baseURL: 'https://api.podium.com/v4',
  headers: { 'Authorization': `Bearer ${process.env.PODIUM_ACCESS_TOKEN}` },
});

const { data } = await podium.get('/locations');
console.log(`Locations: ${data.data.length}`);

import axios from 'axios';

const podium = axios.create({
  baseURL: 'https://api.podium.com/v4',
  headers: { 'Authorization': `Bearer ${process.env.PODIUM_ACCESS_TOKEN}` },
});

const { data } = await podium.get('/locations');
console.log(`Locations: ${data.data.length}`);

import axios from 'axios';

const podium = axios.create({
  baseURL: 'https://api.podium.com/v4',
  headers: { 'Authorization': `Bearer ${process.env.PODIUM_ACCESS_TOKEN}` },
});

const { data } = await podium.get('/locations');
console.log(`Locations: ${data.data.length}`);

import axios from 'axios';

const podium = axios.create({
  baseURL: 'https://api.podium.com/v4',
  headers: { 'Authorization': `Bearer ${process.env.PODIUM_ACCESS_TOKEN}` },
});

const { data } = await podium.get('/locations');
console.log(`Locations: ${data.data.length}`);

import axios from 'axios';

const podium = axios.create({
  baseURL: 'https://api.podium.com/v4',
  headers: { 'Authorization': `Bearer ${process.env.PODIUM_ACCESS_TOKEN}` },
});

const { data } = await podium.get('/locations');
console.log(`Locations: ${data.data.length}`);

import axios from 'axios';

const podium = axios.create({
  baseURL: 'https://api.podium.com/v4',
  headers: { 'Authorization': `Bearer ${process.env.PODIUM_ACCESS_TOKEN}` },
});

const { data } = await podium.get('/locations');
console.log(`Locations: ${data.data.length}`);

import express from 'express';

const app = express();
app.post('/webhooks/podium', express.json(), async (req, res) => {
  const { type, data } = req.body;

  const handlers: Record<string, (data: any) => Promise<void>> = {
    'message.received': async (d) => {
      console.log(`Message from ${d.attributes['contact-phone']}: ${d.attributes.body}`);
    },
    'message.sent': async (d) => {
      console.log(`Message delivered: ${d.id}`);
    },
    'review.created': async (d) => {
      console.log(`New review: ${d.attributes.rating}/5`);
    },
    'payment.completed': async (d) => {
      console.log(`Payment received: $${d.attributes.amount / 100}`);
    },
  };

  const handler = handlers[type];
  if (handler) await handler(data);
  res.status(200).json({ received: true });
});

await podium.post('/webhooks', {
  data: {
    attributes: {
      url: 'https://your-app.com/webhooks/podium',
      events: ['message.received', 'message.sent', 'review.created', 'payment.completed'],
    },
  },
});