Actions72
- Image Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Stack Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
Overview
This node allows you to manage webhooks in Portainer, specifically enabling the deletion of a webhook by its ID. It is useful when you want to programmatically remove webhooks that are no longer needed or valid, helping maintain a clean and organized set of webhook configurations.
A practical example is automating cleanup tasks where expired or unused webhooks should be deleted from your Portainer environment without manual intervention.
Properties
| Name | Meaning |
|---|---|
| Webhook ID | The unique identifier of the webhook to delete. |
| Force Delete | Whether to force deletion even if the webhook resource is currently in use (true/false). |
Output
The node outputs JSON data representing the response from the Portainer API after attempting to delete the specified webhook. Typically, this will confirm successful deletion or provide error details if the operation failed.
No binary data output is involved.
Dependencies
- Requires an API key credential for authenticating with the Portainer API.
- The base URL of the Portainer instance must be configured in the credentials.
- The node sends HTTP DELETE requests to the
/webhooks/{webhookId}endpoint of the Portainer API.
Troubleshooting
Common issues:
- Providing an invalid or non-existent Webhook ID will result in an error from the API.
- Lack of proper API authentication or incorrect API key will cause authorization failures.
- Trying to delete a webhook that is currently in use without setting "Force Delete" may fail.
Error messages and resolutions:
- 404 Not Found: The webhook ID does not exist. Verify the ID is correct.
- 401 Unauthorized: Authentication failed. Check the API key credential configuration.
- 409 Conflict or similar: The webhook is in use and cannot be deleted unless "Force Delete" is enabled.
Links and References
- Portainer API Documentation - Webhooks (for detailed API behavior)
- Portainer Official Website