View as Markdown
ShipHero icon

ShipHero TRIGGER

Order Allocated (Instant)

Emit new event when an order is allocated. See the documentation.
  • Trigger
  • Instant
  • OAuth
  • Webhook delivery

IMPLEMENTATION

Deploy this event source

Connect the user's ShipHero account, configure the source, and choose the webhook where your backend receives events.

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 deployed = await pd.triggers.deploy({
  id: "shiphero-order-allocated-instant",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shiphero: { authProvisionId: "apn_xxxxxxx" },
    shopName: "Shop Name",
  },
  webhookUrl: "https://example.com/webhooks/shiphero",
})

console.log(deployed.id)

MCP exposes on-demand actions. Event sources are deployed through the Connect SDK or API because they continue listening after the initial request.

SCHEMA

Configuration

These inputs define which events the source watches. Dynamic options are loaded from the connected account.

Order Allocated (Instant) configuration
Property Type Description
shopName Shop Name string
The name of the shop. Eg: pipedream-api
Required

01

Connect

Your user authorizes ShipHero through Pipedream managed auth.

02

Deploy

Your backend deploys this source with that user's own configuration.

03

Webhook delivery

Every event is sent to the HTTP endpoint you choose when you deploy the source — as it happens.

OR

On-demand retrieval

No webhook required. Your app or agent can fetch recent events from the trigger events API.

Registry key
shiphero-order-allocated-instant
Version
0.0.1
App
ShipHero
Authentication
OAuth
Delivery
Instant event
Output
Events emitted by ShipHero.