Fluent Commerce Logo
Docs
Sign In
Rule

Changed on:

19 Apr 2024

Overview

Send an payload to an external system, defined by a Setting configuration.

Plugin NameCore Reference Module
Namespace[[account.id]].core

The is a foundational

It provides a base set of general purpose Rules:

  • that other Modules are built upon 
  • or that can be included in your own Workflows

Extensible by design, use this Module as a base to build a solution for the needs of your customers.

UI Description

Send webhook {setting}

Accepts

  • All Orchestration Entities

Actions

Rule parameters

Name

Type

Description

`setting`

`String`

Name of the setting containing the configuration.

See Detailed Technical Description for details on the Setting Structure.

Configuration example

1{
2    "name": "[account].core.SendWebhook",
3    "props": {
4        "setting": "webhook.payment.capture"
5    }
6}

Detailed Technical Description

This will either produce a WebhookAction, or a custom Audit Event if it cannot load the given Setting.

The will be sent to the endpoint defined in the Setting configured in the `setting` parameter.

Managing the configuration details as a Setting provides greater flexibility for managing endpoint changes.

It also makes it easy to manage different endpoints between different sandbox and production environments without managing separate Workflows in each environment.

Setting Structure

The configuration setting is of type `JSON` using the following structure:

Name

Type

Description

`name`

`String`

Name of the to be sent with the

`url`

`String` 

The URL endpoint of the receiver

1{
2  "name": "CapturePayment",
3  "url": "https://example.com"
4}
Workflow Builder (Modeller) Screenshot
No alt provided

Version History

2023-08-02

v23.8.2

Refers to the Product Release Version