ESPRMAdminWebhook
Defined in: src/ESPRMAdminWebhook.ts:11
Shell class for admin webhook integration operations. Methods are added via prototype augmentation in methods/ESPRMAdminWebhook/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminWebhook():
ESPRMAdminWebhook
Returns
Section titled “Returns”ESPRMAdminWebhook
Methods
Section titled “Methods”createWebhookIntegration()
Section titled “createWebhookIntegration()”createWebhookIntegration(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminWebhook/CreateWebhookIntegration.ts:27
Creates a new webhook integration for the deployment.
Parameters
Section titled “Parameters”params
Section titled “params”CreateWebhookIntegrationRequest
The webhook integration configuration including service name and endpoint.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the webhook integration was created.
deleteWebhookEventMapping()
Section titled “deleteWebhookEventMapping()”deleteWebhookEventMapping(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminWebhook/DeleteWebhookEventMapping.ts:27
Deletes a webhook event mapping identified by webhook name and event name.
Parameters
Section titled “Parameters”params
Section titled “params”DeleteWebhookEventMappingParams
The parameters identifying the event mapping to delete.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the event mapping was deleted.
deleteWebhookIntegration()
Section titled “deleteWebhookIntegration()”deleteWebhookIntegration(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminWebhook/DeleteWebhookIntegration.ts:27
Deletes a webhook integration identified by service name and endpoint.
Parameters
Section titled “Parameters”params
Section titled “params”DeleteWebhookIntegrationParams
The parameters identifying the webhook integration to delete.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the webhook integration was deleted.
getWebhookEventMapping()
Section titled “getWebhookEventMapping()”getWebhookEventMapping(
params?):Promise<GetWebhookEventMappingResponse>
Defined in: src/methods/ESPRMAdminWebhook/GetWebhookEventMapping.ts:22
Retrieves the event-to-webhook mapping configuration.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional filtering parameters for the event mapping query.
Returns
Section titled “Returns”Promise<GetWebhookEventMappingResponse>
The response containing webhook event mapping details.
getWebhookIntegrations()
Section titled “getWebhookIntegrations()”getWebhookIntegrations(
params?):Promise<GetWebhookIntegrationsResponse>
Defined in: src/methods/ESPRMAdminWebhook/GetWebhookIntegrations.ts:22
Retrieves the list of configured webhook integrations.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional filtering parameters for the webhook integrations query.
Returns
Section titled “Returns”Promise<GetWebhookIntegrationsResponse>
The response containing webhook integration details.
updateWebhookEventMapping()
Section titled “updateWebhookEventMapping()”updateWebhookEventMapping(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminWebhook/UpdateWebhookEventMapping.ts:27
Updates an existing webhook event mapping configuration.
Parameters
Section titled “Parameters”params
Section titled “params”UpdateWebhookEventMappingRequest
The updated event mapping details including webhook name and event name.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the event mapping was updated.
updateWebhookIntegration()
Section titled “updateWebhookIntegration()”updateWebhookIntegration(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminWebhook/UpdateWebhookIntegration.ts:27
Updates an existing webhook integration configuration.
Parameters
Section titled “Parameters”params
Section titled “params”UpdateWebhookIntegrationRequest
The updated webhook integration details including service name and endpoint.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the webhook integration was updated.