Connector Contracts - Order Update Contract
Interface Contract Flow
Changed on:
13 Dec 2023
Overview
Webhook notifications enable external systems to receive updates about a certain entity when it’s created or modified. These notifications are flexible and can be added at any point in the workflow - it is up to the business requirements to define when these notifications are sent. By definition, a notification is always related to a past event/fact that has already happened in the system (Fluent).
In the order update scenario, the workflow notifies external systems of any order progression or modification through its lifecycle.
API Details
Event Names:
`fc.connect.order.webhook.status-update`Interface Contract
Diagram
Configuration example
1{
2 "$schema": "https://json-schema.org/draft/2020-12/schema",
3 "$id": "https://fluentcommerce.com/event/webhook-notification.json",
4 "type": "object",
5 "title": "Webhook Notification",
6 "description": "Describes the payload of webhook notifications",
7 "default": {},
8 "required": [
9 "id", "name", "accountId", "retailerId", "entityId", "entityRef", "entityType"
10 ],
11 "properties": {
12 "id": {
13 "type": "string",
14 "title": "Unique ID of the event"
15 },
16 "name": {
17 "type": "string",
18 "title": "Name of the event"
19 },
20 "accountId": {
21 "type": "string",
22 "title": "Fluent account ID"
23 },
24 "retailerId": {
25 "type": "string",
26 "title": "Fluent retailer ID"
27 },
28 "entityId": {
29 "type": "string",
30 "title": "Entity ID"
31 },
32 "entityRef": {
33 "type": "string",
34 "title": "Entity reference ID"
35 },
36 "entityType": {
37 "type": "string",
38 "title": "Entity Type"
39 },
40 "entitySubtype": {
41 "type": "string",
42 "title": "Entity SubType - required for some entities"
43 },
44 "rootEntityId": {
45 "type": "string",
46 "title": "Root Entity ID - required for some entities"
47 },
48 "rootEntityType": {
49 "type": "string",
50 "title": "Root Entity Entity Type - required for some entities"
51 },
52 "rootEntityRef": {
53 "type": "string",
54 "title": "Root Entity reference - required for some entities"
55 },
56 "attributes": {
57 "type": "string",
58 "title": "Optional list of attributes"
59 },
60 "entityStatus": {
61 "type": "string",
62 "title": "Not in use - disregard any value"
63 },
64 "type": {
65 "type": "string",
66 "title": "Not in use - disregard any value"
67 },
68 "scheduledOn": {
69 "type": "string",
70 "title": "Not in use - disregard any value"
71 },
72 "meta": {
73 "type": "string",
74 "title": "Not in use - disregard any value"
75 },
76 "trailLogs": {
77 "type": "string",
78 "title": "Not in use - disregard any value"
79 },
80 "errorLogs": {
81 "type": "string",
82 "title": "Not in use - disregard any value"
83 }
84 }
85}Language: json
Request Payload
Property | Description | Type | Required? | Notes |
Version History
2023-08-08
v0.0.0
First release
