Function: registerDynamicWebhooks()

function registerDynamicWebhooks(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  webhookRegistrationResult?: object[];
}>;

Defined in: src/cloud/api/webhooks.ts:52

Registers webhooks.

NOTE: for non-public OAuth apps, webhooks are delivered only if there is a match between the app owner and the user who registered a dynamic webhook.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ url: string; webhooks: object[]; }	-
parameters.url	string	The URL that specifies where to send the webhooks. This URL must use the same base URL as the Connect app. Only a single URL per app is allowed to be registered.
parameters.webhooks?	object[]	A list of webhooks.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; webhookRegistrationResult?: object[]; }>