Webhook Workflow Step

Overview

The Webhook Workflow Step executes external workflow logic via webhook calls. This enables integration with external systems that need to perform actions or return data as part of the order workflow.

Identifier

Configuration Properties

Behavior

What It Does

1. If RunAfterOrderIsSaved is true:
   • Ensures order is fully saved and available via the API before proceeding
2. Creates external order action service for "Webhook"
3. Executes webhook with order, shipment, and workflow step
4. Logs export event to order history
5. If webhook returns updated order data:
   • Updates order Status, OrderType, Tags, Name, Errors, FollowUpDate, Assets, Origin, Properties
6. Handles results:
   • On success: Clears previous errors
   • On failure: Sets error status and optionally cancels workflow

Prerequisites

• Webhook connector must be configured
• External system must implement webhook endpoint

Side Effects

• Webhook called with order data
• Order properties may be updated from webhook response
• Export event logged
• May change order status on error

Business Cases

When to Use

• External validation: Call external system for fraud or credit checks
• Custom logic: Execute business logic in external systems
• System integration: Trigger actions in systems without native connectors
• Dynamic workflow: Let external systems modify order data

Example Scenarios

Scenario 1: Successful Webhook Webhook returns success. Order continues through workflow.

Scenario 2: Webhook Updates Order Webhook returns modified order data. Status, tags, and properties updated on order.

Scenario 3: Webhook Failure with StopOnError Webhook fails, StopOnError=true. Workflow cancelled, error status set.

Scenario 4: Webhook Service Not Found Webhook service not available. Error returned.

Error Handling

Related Steps

• Export Order - Standard order export
• Notification - Send notifications