If this content did not answer your questions, try searching or contacting our support team for further assistance.
acquia-dam-sdk / Components / WebhooksApi
new WebhooksApi(
client):WebhooksApi
Create an instance of the WebhooksApi class.
Create, list, read, ping, edit, and delete Acquia DAM webhook configurations. Create, List, and Delete Workflow Webhooks
Provide an instance of ApiClient.
createAssetsWebhook(
params):Promise<CreateAssetsWebhookResult>
Create a new Assets webhook
Information about the request
Promise<CreateAssetsWebhookResult>
Promise containing the new webhook configuration ID
createWorkflowWebhook(
params):Promise<GetWorkflowWebhookResult>
Create a Workflow webhook
Information about the request
Promise<GetWorkflowWebhookResult>
Promise containing information about the created webhook
https://widenv2.docs.apiary.io/#reference/workflow-webhooks/webhooks/add-new-webhook
deleteAssetsWebhook(
id):Promise<void>
Delete an Assets webhook
string
Assets Webhook configuration ID
Promise<void>
Promise containing no information
deleteWorkflowWebhook(
event):Promise<void>
Delete a Workflow webhook
The event name
Promise<void>
Promise containing no information
https://widenv2.docs.apiary.io/#reference/workflow-webhooks/webhooks/delete-webhook
editAssetsWebhook(
params):Promise<void>
Edit an Assets webhook configuration
Information about the request
Promise<void>
Promise containing no information
getAssetsWebhook(
id):Promise<GetAssetsWebhookResult>
Retrieve information about an Assets webhook
string
Webhook configuration ID
Promise<GetAssetsWebhookResult>
Promise containing information about a webhook
listAssetsWebhooks(
params?):Promise<ListAssetsWebhooksResult>
Retrieve a list of Assets webhooks
Information about the request
Promise<ListAssetsWebhooksResult>
Promise containing a list of Assets webhooks
listWorkflowWebhooks():
Promise<ListWorkflowWebhooksResult>
Retrieve a list of active Workflow webhooks
Promise<ListWorkflowWebhooksResult>
Promise containing a list of Workflow webhooks
https://widenv2.docs.apiary.io/#reference/workflow-webhooks/webhooks/list-all-webhooks
pingAssetsWebhook(
id):Promise<void>
Ping an Assets Webhook
string
Assets Webhook Configuration ID
Promise<void>
Promise containing no information