View as Markdown
Svix icon

Svix ACTION

Create Message

Creates a new message and dispatches it to all of the application's endpoints. See the docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Svix account once, then configure and run Create Message 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-create-message",
  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.

Create Message inputs
Property Type Description
appId Application ID string
The application's ID or UID
Required Dynamic
eventType Event Type string
The event type to dispatch
Required Dynamic
payload Payload object
Body of the message
Required
payloadRetentionPeriod Payload Retention Period integer
The retention period for the payload (in days)
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-create-message
Version
0.0.2
App
Svix
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes