mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node operation, Extension Dry Run Webhook under the Marketplace resource, simulates webhook events related to extension instances in a marketplace environment. It allows users to trigger dry-run webhook calls for various lifecycle events of an extension instance, such as when an extension is added to a context, updated, secret rotated, or removed from a context.

Typical use cases include:

  • Testing webhook integrations without affecting live data.
  • Validating how downstream systems respond to specific extension lifecycle events.
  • Debugging and development of automation workflows that depend on marketplace extension webhooks.

For example, a user can simulate the event "Extension Added To Context" with specific contributor and extension IDs to verify that their system correctly processes this event before deploying it in production.

Properties

Name Meaning
Contributor Id The unique identifier of the contributor associated with the extension instance. Required to specify which contributor's extension is involved.
Extension Id The unique identifier of the extension being referenced. Required to identify the exact extension for the webhook simulation.
Extension Instance Id The ID of the specific extension instance. For this dry run, this value can be arbitrary or made up.
Webhook Kind The type of webhook event to simulate. Options include:
- Extension Added To Context
- Extension Instance Updated
- Extension Instance Secret Rotated
- Extension Instance Removed From Context
Context Id Defines the context ID for the event. If left empty, a random context ID will be generated.
Scopes Defines the scopes associated with the extension instance. If left empty, defaults to the scopes defined in the extension itself. Accepts JSON array input.
Instance Disabled Boolean flag indicating whether the extension instance is disabled. If left empty, a random state will be assigned.
Created At Timestamp string defining when the extension instance was created. If left empty, a random timestamp will be used.
Secret Secret string associated with the extension instance. If left empty, a random secret will be generated but it will not be usable.

Output

The node outputs JSON data representing the simulated webhook event response. This output typically includes details about the extension instance and the webhook event triggered. The structure reflects the data sent back by the API endpoint that handles these dry run webhook simulations.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authentication with the mittwald mStudio API.
  • The node uses the base URL https://api.mittwald.de for API requests.
  • Proper configuration of the API key credential within n8n is necessary to authenticate and authorize requests.

Troubleshooting

  • Invalid or missing required properties: Ensure all required fields like Contributor Id, Extension Id, Extension Instance Id, and Webhook Kind are provided. Missing these will cause errors.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Malformed JSON in Scopes: When providing scopes as JSON, ensure the syntax is correct; otherwise, the request may fail.
  • Random values usage: Leaving optional fields empty results in random values being generated. If deterministic behavior is needed, explicitly provide these values.
  • API endpoint issues: Network connectivity or API downtime at https://api.mittwald.de can cause failures.

Links and References

Discussion