View as Markdown
Deel icon

Deel ACTION

Send Contract Invitation

Send a contract invitation email to a worker for a specific Deel contract. Use this after creating a contract to notify the worker and prompt them to sign. Use List Contracts to find the contract ID. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Deel account once, then configure and run Send Contract Invitation 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: "deel-send-contract-invitation",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    deel: { authProvisionId: "apn_xxxxxxx" },
    contractId: "Contract ID",
    email: "Email",
  },
})

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.

Send Contract Invitation inputs
Property Type Description
contractId Contract ID string
The unique identifier of the Deel contract. Use List Contracts to find contract IDs.
Required
email Email string
The email address to send the invitation to.
Required
locale Locale string
Language locale for the invitation email (e.g., en, de, fr). Defaults to en.
Optional
message Message string
Optional personal message to include in the invitation email.
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
deel-send-contract-invitation
Version
0.0.2
App
Deel
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes