View as Markdown
Svix icon

Svix ACTION

List Messages

List all of the application's messages. See the docs here
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Svix account once, then configure and run List Messages from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "svix-list-messages",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    svix: { authProvisionId: "apn_xxxxxxx" },
    appId: "Application ID",
    eventType: "Event Type",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Messages inputs
Property Type Description
appId Application ID string
The application's ID or UID
Required Dynamic
eventType Event Type string
The event type to retrieve
Optional Dynamic
limit Limit integer
The maximum number of messages to retrieve
Optional
before Before string
List only messages before this timestamp. Note: before and after cannot be used simultaneously.
Optional
after After string
List only messages after this timestamp. Note: before and after cannot be used simultaneously.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
svix-list-messages
Version
0.0.3
App
Svix
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes