View as Markdown
Envoy icon

Envoy ACTION

Create an Invite

Create an Invite to a person to visit a location. See the docs.
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Envoy account once, then configure and run Create an Invite 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: "envoy-create-an-invite",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    envoy: { authProvisionId: "apn_xxxxxxx" },
    expectedArrivalAt: "Arrival date",
    locationId: "Location",
  },
})

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 an Invite inputs
Property Type Description
expectedArrivalAt Arrival date string
A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Required
locationId Location string
Unique identifier of a location.
Required Dynamic
name Name string
Visitor full name.
Required
email Email string
Visitor email address.
Optional
hostEmployeeId Host string
Unique identifier of a host.
Optional Dynamic
expectedDepartureAt Departure date string
A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Optional
notes Private notes string
Enter your private notes.
Optional
sendEmailToInvitee Send email to invitee boolean
Either it should or not send email to invitee
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
envoy-create-an-invite
Version
0.0.2
App
Envoy
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes