Create Webhook subscriptions
/unified/file-storage/webhook-subscriptions
Query Parameters
Refer Specifying query parameters in Truto APIs
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
Excludes the remote_data attribute from the response.
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.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barRequest Body
Refer Writing data using Unified APIs
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
Accepted for compatibility. Microsoft only supports updated for drives, which covers files and folders being created, changed or deleted.
4 supported
createdupdateddeletedallcreatedupdateddeletedallcreatedupdateddeletedallcreatedupdateddeleted+ 3 more
Secret Microsoft repeats in every notification (max 128 characters). When notification_url points at Truto it defaults to the account webhook_secret.
1 supported
The drive (document library) to watch. Changes anywhere in the drive are reported.
3 supported2 required
The unique identifier for a drive
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
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
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
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.
Accepted for compatibility. Microsoft only supports watching a whole drive, so the subscription is always created on the drive root.
5 supported2 required
Ignored; the drive root is always used
Type of resource
drivefolderfilerootchangesfilefolderchangesfilefolderfilefolderrootfolderfile+ 3 more
Opaque value echoed back in every notification (X-Goog-Channel-Token).
2 supported
Response Body
The unique identifier for the webhook subscription
5 supported
The URL where notifications will be sent
5 supported
Types of changes to monitor
4 supported
createdupdateddeletedall
Optional secret for verifying webhook authenticity
1 supported
When the subscription was created
5 supported
The drive being monitored
3 supported
The unique identifier for a drive
When the subscription expires (ISO 8601 datetime)
4 supported
Starting page token for change notifications (Google Drive only)
1 supported
Raw data returned from the remote API call.
The resource being monitored
5 supported
ID of the resource (drive, folder, etc.)
Type of resource
drivefolderfilerootchanges
Provider-generated identifier for the watched resource
5 supported
The URI of the resource being watched
5 supported
Optional token sent with notifications
2 supported
The type of subscription
webhookweb_hook
5 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 jsonimport 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())