Webhooks API

The Egnyte Webhooks API lets you subscribe to real-time events in your Egnyte domain. When a registered event occurs—such as a file upload, folder creation, or permission change—Egnyte sends an HTTP POST request to your specified endpoint with event details. This push model eliminates the need to poll the Events API.

Overview

Webhooks complement the Egnyte Events API by providing push-based notifications instead of requiring your application to poll for changes. When you register a webhook, Egnyte pushes events to your endpoint in near real-time as they occur in your domain.

Key Features

• Real-time notifications — Receive events as they happen, with minimal latency
• Event filtering — Subscribe only to the event types your application needs, using exact names or wildcards (e.g. fs:*, link:*, comment:*)
• Secure delivery — Webhook requests include an authorization header whose value is the authHeader you configure at registration time. Validate this on every incoming request to confirm it originates from Egnyte.
• Automatic retries — Egnyte retries failed deliveries at fixed intervals: immediate, then 1 minute, 10 minutes, and 1 hour (4 attempts total). After all retries are exhausted the webhook registration is disabled.
• SSL required — Your endpoint must have a valid CA-signed TLS certificate; self-signed certificates are rejected.

Common Use Cases

• Sync applications — Update local caches when files change in Egnyte
• Workflow automation — Trigger business processes when specific events occur
• Compliance monitoring — Log permission changes and access events in real time
• Notifications — Alert users or systems when files are uploaded, shared, or modified

Base URL

https://{domain}.egnyte.com/pubapi/v1/webhooks

Authentication

All requests require an OAuth 2.0 Bearer token in the Authorization header:

Authorization: Bearer {access_token}

Your OAuth token must include the Egnyte.webhooks scope.

See Authentication for details on obtaining a token.

When Egnyte delivers events to your endpoint it includes an authorization header whose value is set from the authHeader you configured at registration time. Validate this value on every incoming request to ensure requests originate from Egnyte.

Register a Webhook

Creates a new webhook subscription for specified event types and paths.

Request

POST /pubapi/v1/webhooks

Request Body

Example Request

curl -i -X POST "https://{domain}.egnyte.com/pubapi/v1/webhooks" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -d '{
  "url": "https://{redirect_uri_base}/webhook",
  "eventType": [
    "fs:add_file"
  ],
  "path": "/Shared/Documents/Invoices,/Shared/Documents/Samples"
}'

Response

201 Created

Example Response

{
  "webhookId": "c9ac0519-284a-4bee-9574-30ae7891e5dc",
  "expires": 2100000000,
  "status": "enabled"
}

List Webhooks

Returns all webhooks registered for the authenticated user and client ID.

Request

GET /pubapi/v1/webhooks

Example Request

curl -i -X GET "https://{domain}.egnyte.com/pubapi/v1/webhooks" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

200 OK

Returns an array of webhook objects.

Example Response

[
  {
    "webhookId": "c9ac0519-284a-4bee-9574-30ae7891e5dc",
    "expires": 2100000000,
    "status": "enabled"
  },
  {
    "webhookId": "a1bc0519-284a-4bee-9574-30ae7891e5ef",
    "expires": 2100000000,
    "status": "disabled"
  }
]

Get Webhook Details

Returns full configuration details for a specific webhook.

Request

GET /pubapi/v1/webhooks/{webhookId}/details

Path Parameters

Example Request

curl -i -X GET "https://{domain}.egnyte.com/pubapi/v1/webhooks/{webhookId}/details" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

200 OK

Example Response

{
  "webhookId": "c9ac0519-284a-4bee-9574-30ae7891e5dc",
  "expires": 2100000000,
  "status": "enabled",
  "eventType": ["fs:add_file", "fs:delete_file"],
  "path": "/Shared/Documents/Invoices,/Shared/Documents/Samples",
  "authHeader": "Bearer secret-token-12345",
  "url": "https://example.com/webhook"
}

Get Webhook Status

Returns the current status and expiration of a webhook.

Request

GET /pubapi/v1/webhooks/{webhookId}/status

Path Parameters

Example Request

curl -i -X GET "https://{domain}.egnyte.com/pubapi/v1/webhooks/{webhookId}/status" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

200 OK

Example Response

{
  "webhookId": "c9ac0519-284a-4bee-9574-30ae7891e5dc",
  "expires": 2100000000,
  "status": "enabled"
}

Update Webhook Status

Enables or disables a webhook without changing its configuration.

Request

POST /pubapi/v1/webhooks/{webhookId}/status

Path Parameters

Request Body

Example Request

curl -i -X POST "https://{domain}.egnyte.com/pubapi/v1/webhooks/{webhookId}/status" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -d '{
  "status": "disabled"
}'

Response

200 OK

Example Response

{
  "webhookId": "c9ac0519-284a-4bee-9574-30ae7891e5dc",
  "expires": 2100000000,
  "status": "disabled"
}

Update Webhook

Updates the configuration of an existing webhook.

Request

PUT /pubapi/v1/webhooks/{webhookId}

Path Parameters

Request Body

Example Request

curl -i -X PUT "https://{domain}.egnyte.com/pubapi/v1/webhooks/{webhookId}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -d '{
  "url": "https://{redirect_uri_base}/webhook",
  "eventType": [
    "fs:add_file"
  ],
  "path": "/Shared/Documents/Invoices",
  "status": "enabled",
  "authHeader": "Bearer secret-token-12345"
}'

Response

200 OK

Returns no content on successful update.

Delete Webhook

Permanently removes a webhook subscription.

Request

DELETE /pubapi/v1/webhooks/{webhookId}

Path Parameters

Example Request

curl -i -X DELETE "https://{domain}.egnyte.com/pubapi/v1/webhooks/{webhookId}" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

204 No Content

Returns no content on successful deletion.

Get Current User Information

Returns information about the authenticated user and OAuth client. Useful for verifying token validity and inspecting active scopes. This endpoint requires a valid OAuth token but no specific scope.

Request

GET /pubapi/v1/whoami

Example Request

curl -i -X GET "https://{domain}.egnyte.com/pubapi/v1/whoami" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

200 OK

Example Response

{
  "clientId": "hweb8adyh3gumiypa45qdgkm",
  "username": "johndoe",
  "domain": "apidemo",
  "scopes": ["Egnyte.webhooks"]
}

Webhook Payload

Egnyte sends an HTTP POST with Content-Type: application/json. The body is an object with a data array:

{
  "data": [
    {
      "eventId": "...",
      "domain": "...",
      "timestamp": 1710000000000,
      "user": {
        "id": 1,
        "displayName": "...",
        "username": "...",
        "email": "..."
      },
      "actionSource": "...",
      "eventType": "fs:add_file",
      "webhookId": "...",
      "data": {}
    }
  ]
}

Each item in data contains:

User Object Fields

Your endpoint must respond with HTTP 200 to acknowledge receipt. Any non-200 response code schedules a retry.

Event Types

Supported Event Types

The following event types and wildcards are supported. Wildcards are only available for the categories marked below.

File System (fs:*)

Subscribable via fs:* or specific event names.

• fs:add_file — targetEntryId, targetGroupId, targetFileChecksum, targetPath, itemType ('file' or 'version')
• fs:add_folder — targetPath
• fs:copy_file — sourcePath, targetPath, targetEntryId, targetGroupId, targetFileChecksum
• fs:copy_folder — sourcePath, targetPath
• fs:move_file — sourcePath, targetPath, targetGroupId, targetEntryId
• fs:move_folder — sourcePath, targetPath
• fs:delete_file — targetGroupId, targetEntryId, targetPath, targetFileChecksum, itemType (optional)
• fs:delete_folder — targetPath
• fs:restore_from_trash — targetPath, isFolder (boolean); also targetEntryId, targetGroupId, targetFileChecksum, itemType (optional) for files
• fs:delete_from_trash — targetPath
• fs:lock_file — targetEntryId, targetGroupId, targetFileChecksum, targetPath
• fs:unlock_file — targetEntryId, targetGroupId, targetFileChecksum, targetPath
• fs:upload_link — uploadLinkUrl, filePath, fileChecksum, fileGroupId, fileEntryId
• fs:folder_project_activity — targetPath

Links (link:*)

Subscribable via link:* or specific event names.

• link:create — (no additional fields)
• link:create_download_link — sourcePath, linkId, linkType ('file' or 'folder'), linkURL
• link:create_upload_link — sourcePath, linkId, linkType ('upload'), linkURL
• link:delete — (no additional fields)
• link:delete_download_link — sourcePath, linkId, linkType ('file' or 'folder'), linkURL
• link:delete_upload_link — sourcePath, linkId, linkType ('upload'), linkURL

Comments (comment:*)

Subscribable via comment:* or specific event names.

• comment:set_comment — targetPath, comment
• comment:remove_comment — targetPath, optional comment

Permissions (permission:*)

Subscribable via permission:* or permission:permission_change.

• permission:permission_change — folderPath, newPrivilege, oldPrivilege, assignerId; nullable: assignee, assigneeId, assigner, groupName

Groups

No wildcard is available for group events. Subscribe using specific event names.

All group events include user (id, fullName, userName, email), groupName, and groupId.

• group:create — members (array), owner
• group:delete — (no additional fields)
• group:rename — (no additional fields)
• group:add_members — members (array)
• group:remove_members — members (array)
• group:add_owner — owner
• group:remove_owner — owner

Workflows

No wildcard is available for workflow events. Subscribe using specific event names.

All workflow events include:

• workflow object: id, name, displayId, type, actionStatus, optional templateId
• firstEntity object: type, filePath, entryID, groupID

Events:

• workflow:created — additionally definitionJson
• workflow:completed — additionally completionStatusCode, totalNumberOfSteps, completionDate
• workflow:approvaltask_approved — additionally step (id, name, type), assignee (id, displayName, username, email), totalNumberOfSteps, completionDate, creationDate
• workflow:approvaltask_rejected — same as workflow:approvaltask_approved

Metadata (meta:*)

Subscribable via meta:* or specific event names.

• meta:add_metadata_key — targetPath, targetGroupId, namespace, key
• meta:delete_metadata_key — targetPath, targetGroupId, namespace, key

User Provisioning (user:*)

user:create, user:delete, user:disable, user:enable events are implemented in the backend but not yet supported in v1. They will be available in a future release.

Error Codes

All error responses share a common JSON structure:

{
  "code": "hook_invalid_url",
  "message": "ENOTFOUND notexistingdomainname.com",
  "details": "..."
}

Error Codes

Code Examples

POST /pubapi/v1/webhooks

curl -i -X POST "https://{domain}.egnyte.com/pubapi/v1/webhooks" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -d '{"url":"https://example.com/webhook","eventType":["fs:add_file","fs:delete_file"],"path":"/Shared/Documents","authHeader":"Bearer my-secret-token"}'

GET /pubapi/v1/webhooks

curl -i -X GET "https://{domain}.egnyte.com/pubapi/v1/webhooks" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

GET /pubapi/v1/webhooks/{wh['webhookId']}/details

curl -i -X GET "https://{domain}.egnyte.com/pubapi/v1/webhooks/{wh['webhookId']}/details" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Webhooks vs. Events API

Related Resources

• Events API — Poll-based event retrieval for historical data
• Authentication — How to obtain OAuth tokens for webhook registration
• Best Practices — Rate limiting, error handling, and security recommendations