Shopware icon

Shopware

Shopware

Actions778

Webhook → Update Webhook

AI-generated

Overview

This node operation updates an existing webhook in the Shopware system. It allows users to modify webhook properties such as the webhook's identifier, name, event name, URL, activation status, error count, and other metadata. This operation is useful for managing webhook configurations dynamically, for example, updating the URL to which webhook events are sent or changing the webhook's active state.

Use Case Examples

  1. Updating a webhook's URL after a server migration to ensure events are sent to the new endpoint.
  2. Changing the event name or activation status of a webhook to control which events trigger the webhook and whether it is currently active.

Properties

Name Meaning
Id Identifier for the webhook, used to specify which webhook to update.
Response Data format for the response, can be empty if no response is provided.
Name The name of the webhook.
Event Name The event name that triggers the webhook.
Url The URL to which the webhook sends data.
Only Live Version Boolean flag indicating if only the live version of the webhook should be considered.
Error Count Number of errors recorded for the webhook.
Active Boolean flag indicating if the webhook is active.
App Id Identifier for the associated app.
Created At Timestamp when the webhook was created.
Updated At Timestamp when the webhook was last updated.
App JSON object containing detailed app-related data associated with the webhook.

Output

JSON

  • id - Identifier of the updated webhook.
  • name - Name of the updated webhook.
  • eventName - Event name associated with the webhook.
  • url - URL to which the webhook sends data.
  • onlyLiveVersion - Indicates if only the live version is used.
  • errorCount - Number of errors recorded for the webhook.
  • active - Indicates if the webhook is active.
  • appId - Identifier of the associated app.
  • createdAt - Creation timestamp of the webhook.
  • updatedAt - Last update timestamp of the webhook.
  • app - Detailed app-related JSON data associated with the webhook.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the 'Id' property is correctly set to the webhook you want to update; otherwise, the update will fail.
  • Verify that the URL provided is valid and accessible to avoid webhook delivery issues.
  • If the API returns authentication errors, check that the Shopware Admin API credentials are correctly configured.
  • Timeouts or SSL issues can occur; adjust the 'Timeout' and 'Ignore SSL Issues' settings in the request options if needed.

Discussion