Author:
Fluent Commerce
Changed on:
24 Oct 2023
Describes Fluent’s approach to name messages used by the module’s workflows. The message is a mode of communication between two different systems. The naming convention helps to keep all messages uniform and consistent across all Fluent modules allowing partners to understand and adopt the format and follow it during their customisation.
A message can be of 2 types:
These domains are based on - Domain Model
Fluent brings a list of predefined and reserved message names that are used across its standard workflows, but it is still possible for any partner or customer to define new ones, and use them in custom workflows. Each Fluent module should describe all available message names (commands and events) that are part of the module.
Public names are for public API or cross-domain use.
`<fluentcommerce>.<connector/module><domain>.<action/event name>`
`fc.connect.product.upsert`
`<fluentcommerce>.<domain>.<action/event name>`
`<domain>:<entity>:<event name>`
`fluentcommerce`
`acme.connect.product.upsert`
Internal names are for all intermediary steps of a flow and local to the domain and workflow.
`<domain>:internal:<step-name>`
Domain | Command (actions) | Event (Internal) | Webhooks (external events) | Domain dependencies |
Order | fc.connect.order.create | fc.connect.order.webhook.status-update | ||
Product | fc.connect.product.upsert (UPSERT_PRODUCT) fc.connect.product.category.upsert (UPSERT_CATEGORY) | |||
Fulfilment | fc.connect.location.create fc.connect.location.upsert | |||
Payment | fc.connect.order.transaction.add (FINANCIAL_TRANSACTION) | fc.connect.payment.capture fc.connect.payment.authorise fc.connect.payment.refund | fc.connect.payment.capture fc.connect.payment.authorise fc.connect.payment.refund |
Copyright © 2024 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.