EmailConnect icon

EmailConnect

Interact with EmailConnect API for email automation

Actions12

Overview

This node interacts with the EmailConnect API to manage webhooks related to email automation. Specifically, the "Delete Webhook" operation allows users to remove an existing webhook by its ID. This is useful in scenarios where a webhook URL is no longer valid or needed, such as when changing the endpoint that processes incoming email data or cleaning up unused webhooks.

Practical examples include:

  • Removing a webhook that was set up for testing purposes.
  • Deleting a webhook after migrating to a new email processing service.
  • Cleaning up obsolete webhooks to maintain security and reduce clutter.

Properties

Name Meaning
Webhook ID The unique identifier of the webhook to delete. This is required to specify which webhook should be removed.

Output

The output JSON contains a confirmation of the deletion operation with two fields:

  • success: A boolean indicating whether the deletion was successful (true).
  • webhookId: The ID of the webhook that was deleted.

Example output JSON:

{
  "success": true,
  "webhookId": "the-id-of-the-deleted-webhook"
}

No binary data is output by this operation.

Dependencies

  • Requires an API key credential to authenticate requests to the EmailConnect API.
  • The node makes HTTP DELETE requests to the /api/webhooks/{webhookId} endpoint of the EmailConnect API.
  • Proper network connectivity to the EmailConnect API server is necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent webhook ID will likely result in an error from the API.
    • Network connectivity problems can cause request failures.
    • Insufficient permissions or invalid API credentials will prevent successful deletion.

  • Error messages:

    • Errors returned by the API typically include messages indicating the webhook was not found or access denied.
    • If the node throws an error about missing parameters, ensure the "Webhook ID" property is correctly set.

  • Resolutions:

    • Verify the webhook ID exists and is correct.
    • Check API credentials and permissions.
    • Ensure the EmailConnect API service is reachable from your environment.
    • Use the node's "Continue On Fail" option to handle errors gracefully if deleting multiple webhooks in batch.

Links and References

Discussion