Skip to content
POST /unified/file-storage/webhook-subscriptions

Query Parameters

Refer Specifying query parameters in Truto APIs

Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). When the upstream body exceeds 1 MiB, data is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }. debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_enforce_write_schemaboolean

Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

notification_urlstring
required·

HTTPS URL that Microsoft Graph sends change notifications to. Use https://api.truto.one/integrated-account-webhook/<integrated_account_id> to receive unified record:* events through your Truto webhooks.

5 supported5 required
Box
required
Google Drive
required
Google Sheets
required
OneDrive
required
SharePoint
required
change_typesstring[]

Accepted for compatibility. Microsoft only supports updated for drives, which covers files and folders being created, changed or deleted.

4 supported
Box
supported
Google Drive
supported
OneDrive
supported
SharePoint
supported
Possible values:
createdupdateddeletedallcreatedupdateddeletedallcreatedupdateddeletedall+ 3 more
client_statestring

Secret Microsoft repeats in every notification (max 128 characters). When notification_url points at Truto it defaults to the account webhook_secret.

1 supported
Google Sheets
supported
driveobject

The drive (document library) to watch. Changes anywhere in the drive are reported.

3 supported2 required
OneDrive
required
SharePoint
required
Google Drive
supported
idstring
required·

The unique identifier for a drive

expirationstring · date-time

When the subscription expires (ISO 8601). Microsoft allows at most 42,300 minutes (about 29 days). Later or missing values use the maximum.

4 supported
Google Drive
supported
Google Sheets
supported
OneDrive
supported
SharePoint
supported
lifecycle_notification_urlstring

URL for subscription lifecycle notifications. When notification_url points at Truto it defaults to the same URL, which lets Truto renew the subscription automatically before it expires.

2 supported
OneDrive
supported
SharePoint
supported
page_tokenstring

Optional change feed position to watch from. Defaults to the current position. The response returns it as page_token; use it as your first track sync_token.

1 supported
Google Drive
supported
remote_dataRecord<string, any>

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

resourceobject

Accepted for compatibility. Microsoft only supports watching a whole drive, so the subscription is always created on the drive root.

5 supported2 required
Box
required
Google Sheets
required
Google Drive
supported
OneDrive
supported
SharePoint
supported
idstring
required·

Ignored; the drive root is always used

typestring
required·

Type of resource

Possible values:
drivefolderfilerootchangesfilefolderchangesfilefolderfilefolder+ 3 more
tokenstring

Opaque value echoed back in every notification (X-Goog-Channel-Token).

2 supported
Google Drive
supported
Google Sheets
supported

Response Body

idstring
required·

The unique identifier for the webhook subscription

5 supported
Box
supported
Google Drive
supported
Google Sheets
supported
OneDrive
supported
SharePoint
supported
notification_urlstring
required·

The URL where notifications will be sent

5 supported
Box
supported
Google Drive
supported
Google Sheets
supported
OneDrive
supported
SharePoint
supported
change_typesstring[]

Types of changes to monitor

4 supported
Box
supported
Google Drive
supported
OneDrive
supported
SharePoint
supported
Possible values:
createdupdateddeletedall
client_statestring

Optional secret for verifying webhook authenticity

1 supported
Google Sheets
supported
created_atstring · date-time

When the subscription was created

5 supported
Box
supported
Google Drive
supported
Google Sheets
supported
OneDrive
supported
SharePoint
supported
driveobject

The drive being monitored

3 supported
Google Drive
supported
OneDrive
supported
SharePoint
supported
idstring

The unique identifier for a drive

expirationstring · date-time

When the subscription expires (ISO 8601 datetime)

4 supported
Google Drive
supported
Google Sheets
supported
OneDrive
supported
SharePoint
supported
page_tokenstring

Starting page token for change notifications (Google Drive only)

1 supported
Google Drive
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

resourceobject

The resource being monitored

5 supported
Box
supported
Google Drive
supported
Google Sheets
supported
OneDrive
supported
SharePoint
supported
idstring

ID of the resource (drive, folder, etc.)

typestring

Type of resource

Possible values:
drivefolderfilerootchanges
resource_idstring

Provider-generated identifier for the watched resource

5 supported
Box
supported
Google Drive
supported
Google Sheets
supported
OneDrive
supported
SharePoint
supported
resource_uristring

The URI of the resource being watched

5 supported
Box
supported
Google Drive
supported
Google Sheets
supported
OneDrive
supported
SharePoint
supported
tokenstring

Optional token sent with notifications

2 supported
Google Drive
supported
Google Sheets
supported
typestring

The type of subscription

Possible values:
webhookweb_hook
5 supported
Box
supported
Google Drive
supported
Google Sheets
supported
OneDrive
supported
SharePoint
supported
truto unified file-storage webhooksubscriptions \
  -m create \
  -a '<integrated_account_id>' \
  -b '{
  "notification_url": "your_notification_url",
  "resource": {},
  "change_types": [],
  "drive": {},
  "expiration": "your_expiration",
  "page_token": "your_page_token",
  "client_state": "your_client_state",
  "token": "your_token",
  "lifecycle_notification_url": "your_lifecycle_notification_url",
  "remote_data": {}
}' \
  -o json
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.create(
  'file-storage',
  'webhooksubscriptions',
  {
  "notification_url": "your_notification_url",
  "resource": {},
  "change_types": [],
  "drive": {},
  "expiration": "your_expiration",
  "page_token": "your_page_token",
  "client_state": "your_client_state",
  "token": "your_token",
  "lifecycle_notification_url": "your_lifecycle_notification_url",
  "remote_data": {}
},
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.create(
        "file-storage",
        "webhooksubscriptions",
        {
        "notification_url": "your_notification_url",
        "resource": {},
        "change_types": [],
        "drive": {},
        "expiration": "your_expiration",
        "page_token": "your_page_token",
        "client_state": "your_client_state",
        "token": "your_token",
        "lifecycle_notification_url": "your_lifecycle_notification_url",
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
curl -X POST 'https://api.truto.one/unified/file-storage/webhook-subscriptions?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "notification_url": "your_notification_url",
  "resource": {},
  "change_types": [],
  "drive": {},
  "expiration": "your_expiration",
  "page_token": "your_page_token",
  "client_state": "your_client_state",
  "token": "your_token",
  "lifecycle_notification_url": "your_lifecycle_notification_url",
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "notification_url": "your_notification_url",
  "resource": {},
  "change_types": [],
  "drive": {},
  "expiration": "your_expiration",
  "page_token": "your_page_token",
  "client_state": "your_client_state",
  "token": "your_token",
  "lifecycle_notification_url": "your_lifecycle_notification_url",
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/file-storage/webhook-subscriptions?integrated_account_id=${integratedAccountId}`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/file-storage/webhook-subscriptions"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "notification_url": "your_notification_url",
    "resource": {},
    "change_types": [],
    "drive": {},
    "expiration": "your_expiration",
    "page_token": "your_page_token",
    "client_state": "your_client_state",
    "token": "your_token",
    "lifecycle_notification_url": "your_lifecycle_notification_url",
    "remote_data": {}
}

response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())