SDK Reference

npm install @shippulse/js

import { ShipPulse } from "@shippulse/js";

const sp = new ShipPulse({ apiKey: "sp_live_..." });

// List testimonials
const testimonials = await sp.testimonials.list({ status: "approved" });

// Create a changelog entry
await sp.changelog.create({
  title: "Dark mode is here",
  body: "<p>We shipped dark mode for all widgets.</p>",
  type: "feature",
  published: true,
});

// Get monitors
const monitors = await sp.monitors.list();

npm install @shippulse/react @shippulse/js

import { ShipPulseProvider } from "@shippulse/react";

function App({ children }) {
  return (
    <ShipPulseProvider apiKey="sp_live_...">
      {children}
    </ShipPulseProvider>
  );
}

import { useTestimonials, useChangelog, useMonitors } from "@shippulse/react";

function Wall() {
  const { data, isLoading, error } = useTestimonials({ status: "approved" });
  if (isLoading) return <p>Loading...</p>;
  return data.map((t) => <div key={t.id}>{t.content}</div>);
}

function ChangelogFeed() {
  const { data } = useChangelog({ limit: 10 });
  return data.map((e) => <article key={e.id}>{e.title}</article>);
}

function StatusBar() {
  const { data } = useMonitors();
  const allUp = data?.every((m) => m.current_status === "up");
  return <span>{allUp ? "All systems operational" : "Issues detected"}</span>;
}

npm install @shippulse/node

import { verifyWebhookSignature } from "@shippulse/node";

app.post("/webhooks/shippulse", (req, res) => {
  const isValid = verifyWebhookSignature(
    req.body,
    req.headers["x-shippulse-signature"],
    process.env.SHIPPULSE_WEBHOOK_SECRET
  );

  if (!isValid) return res.status(401).send("Invalid signature");

  const event = req.body;
  console.log("Event:", event.type, event.data);

  res.status(200).send("OK");
});

import { createServerClient } from "@shippulse/node";

const sp = createServerClient({ apiKey: process.env.SHIPPULSE_API_KEY });

// All methods from @shippulse/js are available
const approved = await sp.testimonials.list({ status: "approved" });