SendWebhook
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.
UI Description
Send webhook {setting}
Accepts
- All Orchestration Entities
Actions
- This Rule produces a WebhookAction.
Rule parameters
Name | Type | Description |
| | 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`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`Name | Type | Description |
| | Name of the Event to be sent with the Webhook |
| | 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
v23.8.2
Refers to the Product Release Version
