Actions86
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
- Environment Actions
- Image Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Setting Actions
- Stack Actions
- System Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
Webhook → Delete
AI-generatedOverview
This node operation deletes a webhook resource in Portainer by its ID. It is useful for managing and cleaning up webhooks that are no longer needed or valid. For example, if a webhook is obsolete or compromised, this operation can remove it from the system.
Use Case Examples
- Deleting a webhook by specifying its webhook ID to stop receiving events from that webhook.
- Force deleting a webhook even if it is currently in use.
Properties
| Name | Meaning |
|---|---|
| Webhook ID | The ID of the webhook to be deleted, required to identify which webhook to remove. |
| Force Delete | A boolean flag indicating whether to force deletion of the webhook even if it is currently in use. |
Output
JSON
statusCode- HTTP status code returned from the delete request indicating success or failure.body- Response body from the delete request, typically empty or containing confirmation details.
Dependencies
- Portainer API with an API key credential for authentication
Troubleshooting
- Ensure the webhook ID is correct and exists in Portainer; otherwise, the delete operation will fail with a not found error.
- If force delete is not enabled and the webhook is in use, the operation may fail; enable force delete to override this.
- Check API key permissions to ensure the user has rights to delete webhooks.
Links
- Portainer Webhooks API Documentation - Official API documentation for managing webhooks in Portainer, including delete operations.