View as Markdown
Envoy icon

Envoy TRIGGER

New event when a visitor is invited

Emit new event for each invitations to a person or a group of people to visit a location. See the docs.
  • Trigger
  • Polling
  • OAuth
  • Webhook delivery

IMPLEMENTATION

Deploy this event source

Connect the user's Envoy 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: "envoy-visitor-invited",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    envoy: { authProvisionId: "apn_xxxxxxx" },
    timer: { "intervalSeconds": 900 },
  },
  webhookUrl: "https://example.com/webhooks/envoy",
})

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.

New event when a visitor is invited configuration
Property Type Description
timer Watching timer $.interface.timer
How often to watch the summaries.
Required

01

Connect

Your user authorizes Envoy 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 — after each poll.

OR

On-demand retrieval

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

Registry key
envoy-visitor-invited
Version
0.0.1
App
Envoy
Authentication
OAuth
Delivery
Polling source
Output
Events emitted by Envoy.