com.box.sdkgen.managers.webhooks

Class WebhooksManager

Object

WebhooksManager

public class WebhooksManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebhooksManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	WebhooksManager()
protected	WebhooksManager(WebhooksManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
Webhook	createWebhook(CreateWebhookRequestBody requestBody) Creates a webhook.
Webhook	createWebhook(CreateWebhookRequestBody requestBody, CreateWebhookHeaders headers) Creates a webhook.
void	deleteWebhookById(String webhookId) Deletes a webhook.
void	deleteWebhookById(String webhookId, DeleteWebhookByIdHeaders headers) Deletes a webhook.
Authentication	getAuth()
NetworkSession	getNetworkSession()
Webhook	getWebhookById(String webhookId) Retrieves a specific webhook.
Webhook	getWebhookById(String webhookId, GetWebhookByIdHeaders headers) Retrieves a specific webhook.
Webhooks	getWebhooks() Returns all defined webhooks for the requesting application.
Webhooks	getWebhooks(GetWebhooksHeaders headers) Returns all defined webhooks for the requesting application.
Webhooks	getWebhooks(GetWebhooksQueryParams queryParams) Returns all defined webhooks for the requesting application.
Webhooks	getWebhooks(GetWebhooksQueryParams queryParams, GetWebhooksHeaders headers) Returns all defined webhooks for the requesting application.
Webhook	updateWebhookById(String webhookId) Updates a webhook.
Webhook	updateWebhookById(String webhookId, UpdateWebhookByIdHeaders headers) Updates a webhook.
Webhook	updateWebhookById(String webhookId, UpdateWebhookByIdRequestBody requestBody) Updates a webhook.
Webhook	updateWebhookById(String webhookId, UpdateWebhookByIdRequestBody requestBody, UpdateWebhookByIdHeaders headers) Updates a webhook.
static boolean	validateMessage(String body, Map<String,String> headers, String primaryKey) Validate a webhook message by verifying the signature and the delivery timestamp
static boolean	validateMessage(String body, Map<String,String> headers, String primaryKey, Integer maxAge) Validate a webhook message by verifying the signature and the delivery timestamp
static boolean	validateMessage(String body, Map<String,String> headers, String primaryKey, String secondaryKey) Validate a webhook message by verifying the signature and the delivery timestamp
static boolean	validateMessage(String body, Map<String,String> headers, String primaryKey, String secondaryKey, Integer maxAge) Validate a webhook message by verifying the signature and the delivery timestamp

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

WebhooksManager

public WebhooksManager()

WebhooksManager

protected WebhooksManager(WebhooksManager.Builder builder)

Method Detail

getWebhooks

public Webhooks getWebhooks()

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.

getWebhooks

public Webhooks getWebhooks(GetWebhooksQueryParams queryParams)

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.

Parameters:

queryParams - Query parameters of getWebhooks method

getWebhooks

public Webhooks getWebhooks(GetWebhooksHeaders headers)

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.

Parameters:

headers - Headers of getWebhooks method

getWebhooks

public Webhooks getWebhooks(GetWebhooksQueryParams queryParams,
                            GetWebhooksHeaders headers)

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.

Parameters:

queryParams - Query parameters of getWebhooks method

headers - Headers of getWebhooks method

createWebhook

public Webhook createWebhook(CreateWebhookRequestBody requestBody)

Creates a webhook.

Parameters:

requestBody - Request body of createWebhook method

createWebhook

public Webhook createWebhook(CreateWebhookRequestBody requestBody,
                             CreateWebhookHeaders headers)

Creates a webhook.

Parameters:

requestBody - Request body of createWebhook method

headers - Headers of createWebhook method

getWebhookById

public Webhook getWebhookById(String webhookId)

Retrieves a specific webhook.

Parameters:

webhookId - The ID of the webhook. Example: "3321123"

getWebhookById

public Webhook getWebhookById(String webhookId,
                              GetWebhookByIdHeaders headers)

Retrieves a specific webhook.

Parameters:

webhookId - The ID of the webhook. Example: "3321123"

headers - Headers of getWebhookById method

updateWebhookById

public Webhook updateWebhookById(String webhookId)

Updates a webhook.

Parameters:

webhookId - The ID of the webhook. Example: "3321123"

updateWebhookById

public Webhook updateWebhookById(String webhookId,
                                 UpdateWebhookByIdRequestBody requestBody)

Updates a webhook.

Parameters:

webhookId - The ID of the webhook. Example: "3321123"

requestBody - Request body of updateWebhookById method

updateWebhookById

public Webhook updateWebhookById(String webhookId,
                                 UpdateWebhookByIdHeaders headers)

Updates a webhook.

Parameters:

webhookId - The ID of the webhook. Example: "3321123"

headers - Headers of updateWebhookById method

updateWebhookById

public Webhook updateWebhookById(String webhookId,
                                 UpdateWebhookByIdRequestBody requestBody,
                                 UpdateWebhookByIdHeaders headers)

Updates a webhook.

Parameters:

webhookId - The ID of the webhook. Example: "3321123"

requestBody - Request body of updateWebhookById method

headers - Headers of updateWebhookById method

deleteWebhookById

public void deleteWebhookById(String webhookId)

Deletes a webhook.

Parameters:

webhookId - The ID of the webhook. Example: "3321123"

deleteWebhookById

public void deleteWebhookById(String webhookId,
                              DeleteWebhookByIdHeaders headers)

Deletes a webhook.

Parameters:

webhookId - The ID of the webhook. Example: "3321123"

headers - Headers of deleteWebhookById method

validateMessage

public static boolean validateMessage(String body,
                                      Map<String,String> headers,
                                      String primaryKey)

Validate a webhook message by verifying the signature and the delivery timestamp

Parameters:

body - The request body of the webhook message

headers - The headers of the webhook message

primaryKey - The primary signature to verify the message with

validateMessage

public static boolean validateMessage(String body,
                                      Map<String,String> headers,
                                      String primaryKey,
                                      String secondaryKey)

Validate a webhook message by verifying the signature and the delivery timestamp

Parameters:

body - The request body of the webhook message

headers - The headers of the webhook message

primaryKey - The primary signature to verify the message with

secondaryKey - The secondary signature to verify the message with

validateMessage

public static boolean validateMessage(String body,
                                      Map<String,String> headers,
                                      String primaryKey,
                                      Integer maxAge)

Validate a webhook message by verifying the signature and the delivery timestamp

Parameters:

body - The request body of the webhook message

headers - The headers of the webhook message

primaryKey - The primary signature to verify the message with

maxAge - The maximum age of the message in seconds, defaults to 10 minutes

validateMessage

public static boolean validateMessage(String body,
                                      Map<String,String> headers,
                                      String primaryKey,
                                      String secondaryKey,
                                      Integer maxAge)

Validate a webhook message by verifying the signature and the delivery timestamp

Parameters:

body - The request body of the webhook message

headers - The headers of the webhook message

primaryKey - The primary signature to verify the message with

secondaryKey - The secondary signature to verify the message with

maxAge - The maximum age of the message in seconds, defaults to 10 minutes

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()