View as Markdown
Sanity icon

Sanity TRIGGER

New Document Event (Instant)

Emit new event when a new document is created. See the documentation
  • Trigger
  • Instant
  • API key
  • Webhook delivery

IMPLEMENTATION

Deploy this event source

Connect the user's Sanity 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: "sanity-new-document-event",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sanity: { authProvisionId: "apn_xxxxxxx" },
    name: "Webhook Name",
    dataset: "Dataset",
  },
  webhookUrl: "https://example.com/webhooks/sanity",
})

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 Document Event (Instant) configuration
Property Type Description
name Webhook Name string
The name of the webhook
Required
dataset Dataset string
The dataset to use
Required
on Type string[]
The type of document event(s) to listen for
Required
includeDrafts Include Drafts boolean
Set to true to trigger on changes to draft documents
Optional
includeAllVersions Include All Versions boolean
Set true to trigger on changes to version documents
Optional

01

Connect

Your user authorizes Sanity 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 — as it happens.

OR

On-demand retrieval

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

Registry key
sanity-new-document-event
Version
0.0.1
App
Sanity
Authentication
API key
Delivery
Instant event
Output
Events emitted by Sanity.