Shopware icon

Shopware

Shopware

Actions778

Webhook → Create Webhook

AI-generated

Overview

This node operation creates a webhook in the Shopware system. It allows users to specify details such as the webhook's ID, name, event name, URL, and other optional parameters like activation status, error count, and timestamps. This operation is useful for automating the integration of external systems with Shopware by triggering actions based on specific events.

Use Case Examples

  1. Creating a webhook to notify an external system when a new order is placed in Shopware.
  2. Setting up a webhook to trigger a custom workflow when a product is updated.

Properties

Name Meaning
Response Data format for the response, either basic or detailed.
Id Unique identifier for the webhook.
Name Name of the webhook.
Event Name The event name that triggers the webhook.
Url The URL to which the webhook will send data.
Only Live Version Whether the webhook applies only to the live version.
Error Count Number of errors encountered by the webhook.
Active Whether 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 representing the app configuration and related data.
Request Options Settings for request behavior such as batching, SSL validation, proxy, and timeout.

Output

JSON

  • id - Unique identifier of the created webhook.
  • name - Name of the created webhook.
  • eventName - Event name that triggers the webhook.
  • url - URL to which the webhook sends data.
  • onlyLiveVersion - Indicates if the webhook applies only to the live version.
  • errorCount - Number of errors encountered by 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 - App configuration and related data in JSON format.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure all required fields (Id, Name, Event Name, Url) are provided to avoid validation errors.
  • Check network connectivity and API credentials if the webhook creation fails due to authentication or connection issues.
  • If the webhook does not trigger as expected, verify the event name and URL are correctly configured and accessible.

Discussion