---
title: "File changes"
method: POST
path: "webhooks/fileChanges"
tags: ["Webhooks"]
---

# File changes

`POST webhooks/fileChanges` (webhook)

## Payload

- union
  - object
    - `eventTimestamp` string, required — Timestamp of when the event happened
    - `action` 'CREATED', required
    - `clientId` string, required — The ID of the client
    - `workspaceId` string, nullable, required — The ID of the workspace
    - `resource` 'FILE', required
    - `data` object, required
      - `id` string, required — The ID of the file
      - `createdAt` string, required — The date and time of the creation for the file. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
      - `updatedAt` string, required — The date and time of the last update for the file. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
      - `name` string, required — The name of the file
      - `documentDate` string, nullable, required — The date of the document (not the upload date). ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
      - `mimetype` string, required — The mime type of the file
      - `size` number, required — The size of the file in bytes
      - `folderId` string, nullable, required — The ID of the folder this file was uploaded to.
      - `labelIds` string[], nullable, required — The IDs of the assigned labels
  - object
    - `eventTimestamp` string, required — Timestamp of when the event happened
    - `action` 'DELETED', required
    - `clientId` string, required — The ID of the client
    - `workspaceId` string, nullable, required — The ID of the workspace
    - `resource` 'FILE', required
    - `data` object, required
      - `id` string, required — The ID of the file
      - `createdAt` string, required — The date and time of the creation for the file. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
      - `updatedAt` string, required — The date and time of the last update for the file. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
      - `name` string, required — The name of the file
      - `documentDate` string, nullable, required — The date of the document (not the upload date). ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
      - `mimetype` string, required — The mime type of the file
      - `size` number, required — The size of the file in bytes
      - `folderId` string, nullable, required — The ID of the folder this file was uploaded to.
      - `labelIds` string[], nullable, required — The IDs of the assigned labels
  - object
    - `eventTimestamp` string, required — Timestamp of when the event happened
    - `action` 'UPDATED', required
    - `clientId` string, required — The ID of the client
    - `workspaceId` string, nullable, required — The ID of the workspace
    - `resource` 'FILE', required
    - `data` object, required
      - `id` string, required — The ID of the file
      - `createdAt` string, required — The date and time of the creation for the file. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
      - `updatedAt` string, required — The date and time of the last update for the file. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
      - `name` string, required — The name of the file
      - `documentDate` string, nullable, required — The date of the document (not the upload date). ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
      - `mimetype` string, required — The mime type of the file
      - `size` number, required — The size of the file in bytes
      - `folderId` string, nullable, required — The ID of the folder this file was uploaded to.
      - `labelIds` string[], nullable, required — The IDs of the assigned labels
    - `previousData` object, required
      - `id` string, required — The ID of the file
      - `createdAt` string, required — The date and time of the creation for the file. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
      - `updatedAt` string, required — The date and time of the last update for the file. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
      - `name` string, required — The name of the file
      - `documentDate` string, nullable, required — The date of the document (not the upload date). ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
      - `mimetype` string, required — The mime type of the file
      - `size` number, required — The size of the file in bytes
      - `folderId` string, nullable, required — The ID of the folder this file was uploaded to.
      - `labelIds` string[], nullable, required — The IDs of the assigned labels

## Acknowledgement `200`

Webhook received

---

[API](https://skmtc.net/steuerboard/apis/steuerboard-api.md) · [All operations](https://skmtc.net/steuerboard/apis/steuerboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/steuerboard/steuerboard-api/revisions/80748f72965e/schema)