View as Markdown
Orbit icon

Orbit ACTION

Create Activity

Create a new activity. See the docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Orbit account once, then configure and run Create Activity 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: "orbit-create-activity",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    orbit: { authProvisionId: "apn_xxxxxxx" },
    workspaceSlug: "Workspace Slug",
    workspaceMemberSlug: "Workspace Member Slug",
  },
})

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 Activity inputs
Property Type Description
workspaceSlug Workspace Slug string
The workspace slug to use
Required Dynamic
workspaceMemberSlug Workspace Member Slug string
The workspace member slug to use
Required Dynamic
title Title string
A title for the activity; displayed in the timeline
Required
description Description string
A description for the activity; displayed in the timeline
Optional
link Link string
A URL for the activity; displayed in the timeline
Optional
linkText Link Text string
The text for the timeline link
Optional
weight Weight integer
A custom weight to be used in filters and reports; defaults to 1.
Optional
activityTypeKey Activity Type Key string
The key for a custom activity type for the workspace. Will create a new activity type if it does not exist.
Optional
occurredAt Occurred At string
The date and time the activity occurred; defaults to now.
Optional
properties Properties object
Key-value pairs to provide contextual metadata about an activity.
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
orbit-create-activity
Version
0.0.2
App
Orbit
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes