Everhour icon

Everhour

Interact with Everhour API
Join our community

Actions32

Overview

The "Update Webhook" operation in this node allows users to modify an existing webhook configuration in Everhour. A webhook is a user-defined HTTP callback that triggers notifications when specific events occur within the Everhour platform. This operation updates the target URL where notifications are sent and the list of events the webhook listens for. Optionally, it can filter events by a specific project.

This node operation is beneficial when you want to change where your webhook notifications are delivered or adjust which events trigger those notifications without creating a new webhook from scratch. For example, if your integration endpoint changes or you want to listen to different project events, you can update the webhook accordingly.

Practical examples:

  • Changing the notification URL after migrating your server.
  • Adding or removing event types to control which activities trigger webhook calls.
  • Filtering webhook events to a specific project to reduce noise.

Properties

Name Meaning
Target URL The URL to send webhook notifications to.
Events The list of events to listen for. Options include: Client Created, Client Updated, Estimate Updated, Project Created, Project Removed, Project Updated, Section Created, Section Removed, Section Updated, Task Created, Task Removed, Task Updated, Time Updated, Timer Started, Timer Stopped.
Project ID Optional filter to restrict events to a specific project by its ID.
Webhook ID The unique identifier of the webhook to update.

Output

The output is a JSON object representing the updated webhook resource as returned by the Everhour API. It includes details such as the webhook's ID, target URL, subscribed events, and any filters like project ID.

Example output structure (simplified):

{
  "id": 123,
  "targetUrl": "https://example.com/webhook",
  "events": [
    "api:client:created",
    "api:project:updated"
  ],
  "projectId": "optional-project-id"
}

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Everhour API.
  • The node uses the Everhour API base URL configured in the credentials.
  • Network access to the Everhour API endpoints is necessary.

Troubleshooting

  • Invalid Webhook ID: If the provided webhook ID does not exist, the API will return an error. Verify the webhook ID before updating.
  • Invalid Target URL: Ensure the target URL is a valid and reachable HTTP/HTTPS endpoint.
  • Event List Format: The events property must be an array of valid event strings. Passing incorrect or empty event lists may cause errors.
  • Permission Issues: The API key used must have permissions to update webhooks.
  • API Rate Limits: Frequent updates might hit API rate limits; handle errors accordingly.
  • Empty Update Payload: If neither target URL nor events are provided for update, the request body will be empty, potentially causing an error.

To resolve errors:

  • Double-check all input parameters.
  • Confirm API credentials are correct and have sufficient permissions.
  • Review API response messages for specific error details.

Links and References

Discussion