Egnyte Connect API
API docs by Redocly

Egnyte Connect Webhooks Public API (1.0.0)

Download OpenAPI specification:Download

E-mail: api-support@egnyte.com License: Apache 2.0 Terms of Service

Egnyte Connect Public API - webhooks

Webhooks let your application react to events happening in Egnyte Connect in real time.
The number of webhooks registered for one pair: clientId+domain is limited.

Egnyte Connect APIs

Register a webhook

Endpoint for registering a webhook to a URL with filters, we can define multiple path as a comma separated string upto 100 Endpoint returns ID of newly registered webhook, expiration timestamp and current status.

For webhook payloads documentation see specification of the receiver endpoint:

Webhook Receiver documentation

Authorizations:
CodeGrantAuth
Request Body schema: application/json
url
required
string
eventType
Array of strings (EventType) non-empty
Items Enum: "comment:*" "fs:*" "link:*" "meta:*" "permission:*" "comment:remove_comment" "comment:set_comment" "fs:add_file" "fs:add_folder" "fs:upload_link" "fs:copy_file" "fs:copy_folder" "fs:delete_file" "fs:delete_folder" "fs:delete_from_trash" "fs:move_file" "fs:move_folder" "fs:restore_from_trash" "fs:lock_file" "fs:unlock_file" "fs:folder_project_activity" "link:create" "link:create_download_link" "link:create_upload_link" "link:delete" "link:delete_download_link" "link:delete_upload_link" "meta:add_metadata_key" "meta:delete_metadata_key" "workflow:created" "workflow:completed" "workflow:approvaltask_approved" "workflow:approvaltask_rejected" "group:create" "group:delete" "group:rename" "group:add_members" "group:remove_members" "group:add_owner" "group:remove_owner" "permission:permission_change"
authHeader
string
path
string

Responses

Request samples

Content type
application/json
Example
{
  • "url": "https://example.com",
  • "eventType": [
    ],
  • "path": "/Shared/Documents/Invoices, /Shared/Documents/Samples"
}

Response samples

Content type
application/json
{
  • "webhookId": "c9ac0519-284a-4bee-9574-30ae7891e5dc",
  • "expires": 2100000000,
  • "status": "enabled"
}

Get users webhooks

Returns webhooks ID, expiration timestamp and status.

Authorizations:
CodeGrantAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Update a webhook

Allows for webhook update.

Authorizations:
CodeGrantAuth
path Parameters
webhookId
required
string (WebhookId)

ID of the webhook to update

Request Body schema: application/json
url
required
string
eventType
Array of strings (EventType) non-empty
Items Enum: "comment:*" "fs:*" "link:*" "meta:*" "permission:*" "comment:remove_comment" "comment:set_comment" "fs:add_file" "fs:add_folder" "fs:upload_link" "fs:copy_file" "fs:copy_folder" "fs:delete_file" "fs:delete_folder" "fs:delete_from_trash" "fs:move_file" "fs:move_folder" "fs:restore_from_trash" "fs:lock_file" "fs:unlock_file" "fs:folder_project_activity" "link:create" "link:create_download_link" "link:create_upload_link" "link:delete" "link:delete_download_link" "link:delete_upload_link" "meta:add_metadata_key" "meta:delete_metadata_key" "workflow:created" "workflow:completed" "workflow:approvaltask_approved" "workflow:approvaltask_rejected" "group:create" "group:delete" "group:rename" "group:add_members" "group:remove_members" "group:add_owner" "group:remove_owner" "permission:permission_change"
authHeader
string
path
string
status
string
Enum: "enabled" "disabled"

Responses

Request samples

Content type
application/json
Example
{
  • "url": "https://example.com",
  • "eventType": [
    ],
  • "path": "/Shared/Documents/Invoices",
  • "status": "enabled",
  • "authHeader": "AuthHeader"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": "string"
}

Unregister a webhook

Allows for webhook unregistration.

Authorizations:
CodeGrantAuth
path Parameters
webhookId
required
string (WebhookId)

ID of the webhook to unregister

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": "string"
}

Get webhook status

Returns webhook ID, expiration timestamp and status.

Authorizations:
CodeGrantAuth
path Parameters
webhookId
required
string (WebhookId)

ID of the webhook

Responses

Response samples

Content type
application/json
Example
{
  • "webhookId": "c9ac0519-284a-4bee-9574-30ae7891e5dc",
  • "expires": 2100000000,
  • "status": "enabled"
}

Set webhook status

Allows to set webhook status.

Authorizations:
CodeGrantAuth
path Parameters
webhookId
required
string (WebhookId)

ID of the webhook

Request Body schema: application/json
status
required
string
Enum: "enabled" "disabled"

Responses

Request samples

Content type
application/json
Example
{
  • "status": "enabled"
}

Response samples

Content type
application/json
Example
{
  • "webhookId": "c9ac0519-284a-4bee-9574-30ae7891e5dc",
  • "expires": 2100000000,
  • "status": "enabled"
}

Get webhook details

Returns webhook ID, url, expiration timestamp and status and other important details

Authorizations:
CodeGrantAuth
path Parameters
webhookId
required
string (WebhookId)

ID of the webhook

Responses

Response samples

Content type
application/json
Example
{
  • "webhookId": "c9ac0519-284a-4bee-9574-30ae7891e5dc",
  • "expires": 2100000000,
  • "status": "enabled",
  • "eventType": [
    ],
  • "path": "/path/dummypath,/path/samples",
  • "authHeader": "AuthHeader",
  • "url": "https://myidealurl/?qwer"
}

Get basic information about the user

Returns information about the user making request: data from Egnyte Connect plus clientId of application used.

Authorizations:
CodeGrantAuth

Responses

Response samples

Content type
application/json
{
  • "clientId": "hweb8adyh3gumiypa45qdgkm",
  • "username": "johndoe",
  • "domain": "acme",
  • "scopes": [
    ]
}