View as Markdown
Grist icon

Grist TRIGGER

New or Updated Record (Instant)

Emit new event once a record is updated or newly created in Grist. See the documentation
  • Trigger
  • Instant
  • API key
  • Webhook delivery

IMPLEMENTATION

Deploy this event source

Connect the user's Grist 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: "grist-new-or-updated-record-instant",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    grist: { authProvisionId: "apn_xxxxxxx" },
    docId: "Document ID",
    tableId: "Table ID",
  },
  webhookUrl: "https://example.com/webhooks/grist",
})

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 or Updated Record (Instant) configuration
Property Type Description
docId Document ID string
The ID of the Grist document to operate on. You can find this in the Settings menu of the document.
Required
tableId Table ID string
The ID of the table to operate on.
Required Dynamic

01

Connect

Your user authorizes Grist 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
grist-new-or-updated-record-instant
Version
0.0.1
App
Grist
Authentication
API key
Delivery
Instant event
Output
Events emitted by Grist.