Webhooks associated with a document

1 parameter

docIdstringrequired

A string id (UUID)

1 status code

200A list of webhooks.

webhooksarray<object>required

import { GristFullAPIOctriPreview } from "grist-octri-preview-sdk";

const client = new GristFullAPIOctriPreview({
  baseUrl: "https://docs.getgrist.com/api",
  auth: { apiKey: process.env.API_TOKEN! },
});

const result = await client.webhooks.list({ docId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "webhooks": [
    {
      "fields": {
        "enabled": true,
        "eventTypes": [
          "add",
          "update"
        ],
        "isReadyColumn": null,
        "memo": "Send an email when a project is added",
        "name": "new-project-email",
        "tableId": "Projects",
        "url": "https://example.com/webhook/123",
        "unsubscribeKey": "example_key_abc123"
      },
      "id": "xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx",
      "usage": {
        "lastErrorMessage": null,
        "lastEventBatch": {
          "attempts": 1,
          "errorMessage": null,
          "httpStatus": 200,
          "size": 1,
          "status": "success"
        },
        "lastFailureTime": 1685637500424,
        "lastHttpStatus": 200,
        "lastSuccessTime": 1685637500424,
        "numWaiting": 1,
        "status": "idle",
        "updatedTime": 1685637500424
      }
    }
  ]
}

Request

Response