WebhooksManager

• List all webhooks
• Create webhook
• Get webhook
• Update webhook
• Remove webhook

List all webhooks

Returns all defined webhooks for the requesting application.

This API only returns webhooks that are applied to files or folders that are owned by the authenticated user. This means that an admin can not see webhooks created by a service account unless the admin has access to those folders, and vice versa.

This operation is performed by calling function getWebhooks.

See the endpoint docs at API Reference.

try await client.webhooks.getWebhooks()

Arguments

• queryParams GetWebhooksQueryParams
  • Query parameters of getWebhooks method
• headers GetWebhooksHeaders
  • Headers of getWebhooks method

Returns

This function returns a value of type Webhooks.

Returns a list of webhooks.

Create webhook

Creates a webhook.

This operation is performed by calling function createWebhook.

See the endpoint docs at API Reference.

try await client.webhooks.createWebhook(requestBody: CreateWebhookRequestBody(target: CreateWebhookRequestBodyTargetField(id: folder.id, type: CreateWebhookRequestBodyTargetTypeField.folder), address: "https://example.com/new-webhook", triggers: [CreateWebhookRequestBodyTriggersField.fileUploaded]))

Arguments

• requestBody CreateWebhookRequestBody
  • Request body of createWebhook method
• headers CreateWebhookHeaders
  • Headers of createWebhook method

Returns

This function returns a value of type Webhook.

Returns the new webhook object.

Get webhook

Retrieves a specific webhook.

This operation is performed by calling function getWebhookById.

See the endpoint docs at API Reference.

try await client.webhooks.getWebhookById(webhookId: webhook.id!)

Arguments

• webhookId String
  • The ID of the webhook. Example: "3321123"
• headers GetWebhookByIdHeaders
  • Headers of getWebhookById method

Returns

This function returns a value of type Webhook.

Returns a webhook object.

Update webhook

Updates a webhook.

This operation is performed by calling function updateWebhookById.

See the endpoint docs at API Reference.

try await client.webhooks.updateWebhookById(webhookId: webhook.id!, requestBody: UpdateWebhookByIdRequestBody(address: "https://example.com/updated-webhook"))

Arguments

• webhookId String
  • The ID of the webhook. Example: "3321123"
• requestBody UpdateWebhookByIdRequestBody
  • Request body of updateWebhookById method
• headers UpdateWebhookByIdHeaders
  • Headers of updateWebhookById method

Returns

This function returns a value of type Webhook.

Returns the new webhook object.

Remove webhook

Deletes a webhook.

This operation is performed by calling function deleteWebhookById.

See the endpoint docs at API Reference.

try await client.webhooks.deleteWebhookById(webhookId: webhook.id!)

Arguments

• webhookId String
  • The ID of the webhook. Example: "3321123"
• headers DeleteWebhookByIdHeaders
  • Headers of deleteWebhookById method

Returns

This function returns a value of type ``.

An empty response will be returned when the webhook was successfully deleted.