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

404 Location not found

422 Invalid phone

403 Forbidden

messages.write

Resources

• Podium API Reference
• Sync Messages

Next Steps

Build messaging workflow:

podium-core-workflow-a