TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

The node updates a single webhook configuration in the Twenty API. It allows users to modify properties of an existing webhook such as its target URL, description, secret for HMAC signature verification, and the operations that trigger the webhook. This is useful when you need to change where webhook events are sent or update security settings without creating a new webhook.

Practical examples:

  • Changing the target URL if your receiving service endpoint changes.
  • Updating the secret key used to authenticate incoming webhook requests.
  • Modifying which events (operations) the webhook listens to.

Properties

Name Meaning
Id The unique identifier of the webhook object to update.
Depth Determines how much related nested data to include in the response:
- 0: Only the primary webhook object.
- 1: Primary object plus directly related objects.
- 2: Includes related objects of related objects.
Target Url The URL where the webhook payloads will be sent.
Description A textual description of the webhook.
Secret An optional secret string used to compute the HMAC signature for webhook payloads, enabling authentication of webhook requests between Twenty and the consumer.
Operations JSON array defining which webhook operations/events this webhook should listen to.

Output

The node outputs the updated webhook object in the json field of the output data. This includes all the webhook's properties after the update, potentially including nested related objects depending on the Depth parameter.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Twenty API.
  • The node uses the Twenty API base URL configured via credentials.
  • No additional external dependencies beyond the Twenty API and n8n core modules.

Troubleshooting

  • Invalid Id: If the provided webhook Id does not exist, the API will return an error indicating the webhook was not found. Verify the Id is correct.
  • Authentication errors: Ensure the API key credential is valid and has permissions to update webhooks.
  • Malformed JSON in Operations: The Operations property expects valid JSON. Invalid JSON syntax will cause parsing errors. Use proper JSON formatting.
  • Invalid Target URL: Providing an invalid URL may cause the API to reject the update. Confirm the URL is well-formed.
  • Permission Denied: If the API user lacks rights to update webhooks, the request will fail. Check API user permissions.

Links and References

Discussion