CONNECT APP
Build with Orbit
Marketing
- API key
MCP
Give your agent Orbit tools
Every Orbit action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Orbit account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "orbit",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create Activity:
const result = await mcp.callTool({
name: "orbit-create-activity",
arguments: {
workspaceSlug: "Workspace Slug",
workspaceMemberSlug: "Workspace Member Slug",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "orbit",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Create Activity:
result = await session.call_tool("orbit-create-activity", {
"workspaceSlug": "Workspace Slug",
"workspaceMemberSlug": "Workspace Member Slug",
})API PROXY
Call the Orbit API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Orbit API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://app.orbit.love/api/v1/workspaces",
})
// Any allowed Orbit endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://app.orbit.love/api/v1/workspaces
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcHAub3JiaXQubG92ZS9hcGkvdjEvd29ya3NwYWNlcw?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Orbit actions from your backend
Connect a user's Orbit account once, then run Create Activity on their behalf from your own code — TypeScript, Python, or plain HTTP.
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",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="orbit-create-activity",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"orbit": {"authProvisionId": "apn_xxxxxxx"},
"workspaceSlug": "Workspace Slug",
"workspaceMemberSlug": "Workspace Member Slug",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "orbit-create-activity",
"configured_props": {
"orbit": { "authProvisionId": "apn_xxxxxxx" },
"workspaceSlug": "Workspace Slug",
"workspaceMemberSlug": "Workspace Member Slug"
}
}'TOOLS
Orbit actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create Activity
actionCreate a new activity. See the docs hereWritev0.0.2 -
Create Member
actionCreate a new member. See the docs hereWritev0.0.2 -
Create Member Note
actionCreate a new member note. See the docs hereWritev0.0.2 -
Get Member by Identity
actionProvide a source and one of username/uid/email params to return a member with that identity, if one exists. Common values for source include github, twitter, and email. See the docs hereRead-onlyv0.0.3 -
List Workspace Slug Options
actionRetrieves available options for the Workspace Slug field.Read-onlyv0.0.1
No Orbit triggers are available yet.
MULTI-APP
Use Orbit with other popular apps
Most products don't stop at one integration. Pair Orbit with the other apps your users rely on, and ship use cases that span both.
- App slug
- orbit
- Authentication
- API key
- Categories
- Marketing
- Actions
- 5
- Triggers
- 0
- API proxy
- Available