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.
client.getWebhooks().getWebhooks()
- queryParams
GetWebhooksQueryParams
- Query parameters of getWebhooks method
- headers
GetWebhooksHeaders
- Headers of getWebhooks method
This function returns a value of type Webhooks
.
Returns a list of webhooks.
Creates a webhook.
This operation is performed by calling function createWebhook
.
See the endpoint docs at API Reference.
client.getWebhooks().createWebhook(new CreateWebhookRequestBody(new CreateWebhookRequestBodyTargetField.CreateWebhookRequestBodyTargetFieldBuilder().id(folder.getId()).type(CreateWebhookRequestBodyTargetTypeField.FOLDER).build(), "https://example.com/new-webhook", Arrays.asList(CreateWebhookRequestBodyTriggersField.FILE_UPLOADED)))
- requestBody
CreateWebhookRequestBody
- Request body of createWebhook method
- headers
CreateWebhookHeaders
- Headers of createWebhook method
This function returns a value of type Webhook
.
Returns the new webhook object.
Retrieves a specific webhook
This operation is performed by calling function getWebhookById
.
See the endpoint docs at API Reference.
client.getWebhooks().getWebhookById(webhook.getId())
- webhookId
String
- The ID of the webhook. Example: "3321123"
- headers
GetWebhookByIdHeaders
- Headers of getWebhookById method
This function returns a value of type Webhook
.
Returns a webhook object
Updates a webhook.
This operation is performed by calling function updateWebhookById
.
See the endpoint docs at API Reference.
client.getWebhooks().updateWebhookById(webhook.getId(), new UpdateWebhookByIdRequestBody.UpdateWebhookByIdRequestBodyBuilder().address("https://example.com/updated-webhook").build())
- webhookId
String
- The ID of the webhook. Example: "3321123"
- requestBody
UpdateWebhookByIdRequestBody
- Request body of updateWebhookById method
- headers
UpdateWebhookByIdHeaders
- Headers of updateWebhookById method
This function returns a value of type Webhook
.
Returns the new webhook object.
Deletes a webhook.
This operation is performed by calling function deleteWebhookById
.
See the endpoint docs at API Reference.
client.getWebhooks().deleteWebhookById(webhook.getId())
- webhookId
String
- The ID of the webhook. Example: "3321123"
- headers
DeleteWebhookByIdHeaders
- Headers of deleteWebhookById method
This function returns a value of type void
.
An empty response will be returned when the webhook was successfully deleted.