Google Sheets

sheets.google.com

Read from and write to spreadsheets programmatically.

Using the Google Sheets API with Trigger.dev

You can use Trigger.dev with any existing Node SDK or even just using fetch. Using io.runTask makes your Google Sheets background job resumable and appear in our dashboard.

Use io.runTask() and the official SDK or fetch.

Use our HTTP endpoint to subscribe to webhooks

Example code using Google Sheets

Below are some working code examples of how you can use Google Sheets with Trigger.dev. These samples are open source and maintained by the community, you can copy and paste them into your own projects.

Insert data into a row in Google Sheets.A job that is triggered by a Google Sheets webhook.

1
import { TriggerClient } from "@trigger.dev/sdk";
2
// Apps Script Docs: https://developers.google.com/apps-script/reference
3
// Triggers Docs: https://developers.google.com/apps-script/guides/triggers
4

5
// Go to https://docs.google.com/spreadsheets
6
// Open a spreadsheet or create a new one
7
// Click on Extensions > Apps Script
8

9
// Add the following code to the script editor:
10

11
// function pushNotification(e) {
12
//   // get endpoint url and secret key from trigger.dev dashboard
13
//   var url = ''
14
//   var secretKey = ''
15

16
//   var payloadData = {
17
//     'message': 'Google Sheets event',
18
//     'details': e // This contains information about the edit event
19
//   };
20

21
//   var payload = JSON.stringify(payloadData);
22

23
//   var options = {
24
//     'method': 'post',
25
//     'contentType': 'application/json',
26
//     'headers': {
27
//       'x-webhook-secret': secretKey
28
//     },
29
//     'payload': payload
30
//   };
31

32
//   UrlFetchApp.fetch(url, options);
33
// }
34

35
// Save the script and click on the clock icon (Triggers) in the sidebar to open the Triggers page
36
// Click on Add Trigger, which will open a dialog box
37
// Choose pushNotification as the function to run
38
// Select event type, e.g. On open, On edit, On change etc.
39
// Click Save
40

41
// Set the GOOGLE_SHEETS_WEBHOOK_SECRET (Secret) in the .env file.
42

43
// Create an HTTP Endpoint, with the Google Sheets details
44
const sheets = client.defineHttpEndpoint({
45
  id: "google-sheets",
46
  source: "sheets.google.com",
47
  icon: "googlesheets",
48
  verify: async (request) => {
49
    const secret = process.env.GOOGLE_SHEETS_WEBHOOK_SECRET;
50
    if (!secret) return { success: false, reason: "Missing Secret" };
51
    if (request.headers.get("x-webhook-secret") === secret)
52
      return { success: true };
53
    return { success: false, reason: "Webhook Secret Match Failed" };
54
  },
55
});
56

57
client.defineJob({
58
  id: "http-google-sheets",
59
  name: "HTTP Google Sheets",
60
  version: "1.0.0",
61
  enabled: true,
62
  // Create a trigger from the HTTP endpoint
63
  trigger: sheets.onRequest(),
64
  run: async (request, io, ctx) => {
65
    const body = await request.json();
66
    await io.logger.info(`Body`, body);
67
  },
68
});