# Envoy — Pipedream Connect

> Join thousands of companies that rely on Envoy to efficiently manage hybrid workplaces, so everyone inside can connect, collaborate, and thrive.

- API slug: `envoy` (use in MCP headers and tool keys)
- Auth: OAuth (Pipedream-managed)
- Categories: Human Resources
- Website: https://envoy.com/
- Managed OAuth scopes: `locations.read` · `companies.read` · `employees.read` · `token.refresh` · `invites.read` · `entries.read` · `invites.write`
- This page (HTML): https://pipedream.com/apps/envoy
- Tools: 3 actions · 2 triggers

## Connect via MCP (recommended)

- Endpoint: `https://remote.mcp.pipedream.net/v3`
- Headers: `Authorization: Bearer <token>` · `x-pd-project-id` · `x-pd-environment` · `x-pd-external-user-id` · `x-pd-app-slug: envoy`

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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": "envoy",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// e.g. run Create an Invite:
const result = await mcp.callTool({
  name: "envoy-create-an-invite",
  arguments: {
    expectedArrivalAt: "Arrival date",
    locationId: "Location",
  },
})
```

Docs: [MCP guide](https://pipedream.com/docs/connect/mcp/developers.md)

## API proxy

For a Envoy endpoint with no pre-built tool, the proxy forwards your request with the connected user's credentials attached.

```bash
# The path segment is the target URL, URL-safe base64 encoded:
# https://api.envoy.com/v1/employees/

curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuZW52b3kuY29tL3YxL2VtcGxveWVlcy8?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
  -H "Authorization: Bearer {access_token}" \
  -H "x-pd-environment: production"
```

Docs: [API proxy guide](https://pipedream.com/docs/connect/api-proxy.md)

## SDK

```ts
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",
  },
})
```

Docs: [Managed auth guide](https://pipedream.com/docs/connect/managed-auth/quickstart.md) · [Tools guide](https://pipedream.com/docs/connect/components.md)

## Actions (3)

### `envoy-create-an-invite` — Create an Invite (Write)

Create an Invite to a person to visit a location. See the docs.

Full schema: https://pipedream.com/apps/envoy/actions/create-an-invite.md

### `envoy-list-employee-id-options` — List Host Options (Read-only)

Retrieves available options for the Host field.

Full schema: https://pipedream.com/apps/envoy/actions/list-employee-id-options.md

### `envoy-list-location-id-options` — List Location Options (Read-only)

Retrieves available options for the Location field.

Full schema: https://pipedream.com/apps/envoy/actions/list-location-id-options.md

## Triggers (2)

### `envoy-visitor-signed-status-changed` — New event when a visitor changes its signed status (Polling)

Emit new event for each visitor who signed in or out. See the docs.

Full schema: https://pipedream.com/apps/envoy/triggers/visitor-signed-status-changed.md

### `envoy-visitor-invited` — New event when a visitor is invited (Polling)

Emit new event for each invitations to a person or a group of people to visit a location. See the docs.

Full schema: https://pipedream.com/apps/envoy/triggers/visitor-invited.md

---

- All apps: https://pipedream.com/apps — index: https://pipedream.com/llms.txt
- Pipedream docs for agents: https://pipedream.com/docs/llms.txt