SendWebhook

Rule

Changed on:

19 Apr 2024

Overview

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

Plugin Name	Core Reference Module
Namespace	{{accountId}}.core

The Core Reference Module is a foundational Reference Module. 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.

Core Reference Module

Overview

The Core Reference Module is a foundational Reference Module. 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.

Features

General purpose Rules to power your Workflows

Change the state of an entity
Send an event to trigger a Ruleset for the same entity
Send a Webhook
Create conditional logic based on the value or presence of a property

Send webhook {setting}

All Orchestration Entities

This Rule produces a WebhookAction.

Name

Type

Description

`setting`

`String`

Name of the setting containing the webhook 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}

Language: json

Detailed Technical Description

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

The Webhook will be sent to the endpoint defined in the Setting configured in the

`setting`

parameter.

Managing the Webhook 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 webhook configuration setting is of type

`JSON`

using the following structure:

Name

Type

Description

`name`

`String`

Name of the Event to be sent with the Webhook

`url`

`String`

The URL endpoint of the Webhook receiver

1{
2  "name": "CapturePayment",
3  "url": "https://example.com"
4}

Language: json

Name: Example Webhook Setting Value

Description:

Example Webhook Setting Value

Workflow Builder (Modeller) Screenshot

Version History

2023-08-02

v23.8.2

Refers to the Product Release Version

Related content

Webhooks

Edited 77 days ago

Fluent Commerce can post standard webhooks to a configured endpoint so that the third-party system can be notified or react to the provided event. For example, common webhook scenarios include order status updates and shipping notifications.

Webhook Receivers

Edited 114 days ago

An overview of how webhooks work in Fluent Commerce, how they are signed, and validated, and what public keys are used.

Webhooks Frequently Asked Questions

Edited 261 days ago

Fluent Commerce doesn't support static IP whitelisting due to AWS Cloud's dynamic nature. Instead, robust authentication measures are in place for webhook security, including cryptographic signing and signature verification. While static IPs aren't recommended, securing webhook endpoints is achievable by configuring unique URLs and firewall rules. Additionally, setting up custom authorizers or message queue validation enhances security. Each webhook establishes a single connection, with inbound and outbound calls dependent on workflow events. For detailed guidance, refer to Fluent's 'Webhook overview' documentation.

Core Reference Module

Edited 122 days ago

Overview

The Core Reference Module is a foundational Reference Module. 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.

Features

General purpose Rules to power your Workflows

Change the state of an entity
Send an event to trigger a Ruleset for the same entity
Send a Webhook
Create conditional logic based on the value or presence of a property

SendEvent

Edited 216 days ago

Send an event to trigger another Ruleset for the same entity.

SendWebhook

Overview

Core Reference Module

UI Description

Accepts

Actions

Rule parameters

Configuration example

Detailed Technical Description

Setting Structure

Workflow Builder (Modeller) Screenshot

Version History

v23.8.2

Related content

Webhooks

Webhook Receivers

Webhooks Frequently Asked Questions

Core Reference Module

SendEvent

Building Blocks

By Type

Helpful Resources

Quick Links