View as Markdown
Salesforce icon

Salesforce ACTION

Create Event

Create a Salesforce calendar event (a meeting or appointment with a start and end time). Use Create Task instead for to-do items with no scheduled time. Use Find Records to get the WhoId (contact or lead) and WhatId (related record) you want to link. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Salesforce account once, then configure and run Create Event 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: "salesforce_rest_api-create-event",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    salesforce_rest_api: { authProvisionId: "apn_xxxxxxx" },
    AcceptedEventInviteeIds: ["Accepted Event Invitee IDs"],
    ActivityDate: "Due Date / Time",
  },
})

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 Event inputs
Property Type Description
AcceptedEventInviteeIds Accepted Event Invitee IDs string[]
One or more Contact or Lead IDs who accepted this event (Salesforce's 15- or 18-character record ID, e.g. 003XX000004TmiQ for a Contact). Use SOQL Query to find Contact or Lead IDs.
Optional
ActivityDate Due Date / Time string
The date/time (ActivityDateTime) of the event, or only the date (ActivityDate) if it is an all-day event.
Required
Description Description string
A text description of the event. Limit: 32,000 characters.
Optional
DurationInMinutes Duration (in minutes) integer
The event length in minutes.
Optional
EndDateTime End Date / Time string
The date/time when the event ends.
Optional
IsAllDayEvent All-Day Event boolean
Whether the event is an all-day event.
Optional
Location Location string
The location of the event.
Optional
Subject Subject string
The subject line of the event. Limit: 255 characters.
Optional
StartDateTime Start Date / Time string
Indicates the start date and time of the event.
Optional
RecurrenceStartDateTime Recurrence Start Date / Time string
Indicates the date and time when the Salesforce Classic recurring event begins.
Optional
RecurrenceEndDateOnly Recurrence End Date string
Indicates the last date on which the event repeats.
Optional
RecurrenceDayOfWeekMask Recurrence Day of Week integer[]
The day(s) of the week on which the event repeats.
Optional
additionalFields Additional Fields object
Other fields to set for this record as name -> value pairs. Values are parsed as JSON where applicable. Example: {"Industry": "Technology", "AnnualRevenue": 1000000}. Use Describe Object to discover valid field names.
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
salesforce_rest_api-create-event
Version
0.4.1
App
Salesforce
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes