API API and Webhooks task guide
8.4.2 Create a Connector and Test It Open Settings > Integrations > Connectors. Select New Connector. Choose the provider, enter the display name, and complete the connection fields exactly as shown. Select Test Connection before saving the connector as active. After a successful test, select Save and then use Run Sync only when business owners are ready. Review the sync history or job panel for start time, completion status, and any items needing attention.
Read article
API API and Webhooks task guide
8.5.1 Create or Update a Webhook Open Settings > Integrations > Webhooks. Select New Webhook or open an existing subscription. Enter the destination address, choose the business events to send, and complete any secret or signing fields shown. Select Save, then run the available test or validation action before enabling the subscription for live events.
Read article
API API and Webhooks task guide
8.4.1 Create, Label, and Revoke API Keys Open Settings > Integrations > API Keys. Review the list first so you do not create a duplicate key for the same system. Select New API Key or Generate Key. Enter a clear purpose name, owner, and any expiry or note fields shown on screen. Select Create, copy the value immediately, and store it in the approved secret vault. When a key is no longer needed, open the row action menu and select Revoke.
Read article
API API and Webhooks task guide
8.6.3 Maintain Mapping Fields and Resolve Queue Conflicts Open the queue row and read the Conflict Label, Conflict Class, and Retry History before making a correction. If the issue is a product link problem, open the product mapping or item linkage screen and correct the SKU, barcode, or linked ERP item before retrying the import. If the issue is a customer match problem, open the customer mapping screen and link the order to the correct CRM customer record. If the issue is a fulfillment or stock mismatch, review the stock sync detail and confirm the selling branch, item availability, and...
Read article
API API and Webhooks task guide
8.3.2 Maintain Your Profile and Verification Settings Open your profile menu, then select My Profile. Review contact details used for integration alerts and approval messages. Open the verification area and complete any required email or phone confirmation steps before production access is granted.
Read article
API API and Webhooks task guide
8.6.5 Open Samples and Implementation Aids Open Samples or Implementation Aids from the integration menu. Choose the sample package closest to your external system or deployment style. Use the sample as a starting point, then record any organization-specific differences in your rollout notes.
Read article
API API and Webhooks task guide
8.4.3 Pause or Disable a Connector Open the connector detail page. Review current sync status and confirm that pausing the connection will not interrupt critical business activity. Use Pause, Disable, or the matching status action shown in the header. Add a reason note so support teams know why the connector was turned off.
Read article
API API and Webhooks task guide
8.2.2 Prepare the Implementation Team Open the integration overview card for the environment you are using. Record the workspace name, environment label, and connection owner in your rollout notes. Ask the implementation team to use the values copied from this workspace only, never from another organization. When a session expires or a token must be renewed, use the approved connection flow shown in the integration panel instead of reusing stale values.
Read article
API API and Webhooks task guide
8.5.3 Retry Failed Deliveries Safely Retry one failed delivery only after the destination system confirms it is ready to receive it. Use bulk retry only when the root cause has been fixed and the business owner approves replay. Review the status again after retry so duplicate or out-of-sequence processing is caught early. STRATEGIC TIP: Give every webhook a business-facing name, such as Payroll Export to BI or Store Orders to WMS. Clear names shorten support calls and reduce mistakes during retry decisions.
Read article
API API and Webhooks task guide
8.5.2 Review Events and Delivery History Open Delivery Log or the webhook detail history panel. Filter by status, event type, connector, or date range. Open a failed or pending row to review the attempt history, response summary, and next action. Use the event catalog or test event action when you need to confirm that a subscription is listening correctly.
Read article
API API and Webhooks task guide
8.6.1 Review Omnichannel and WooCommerce Sync Open Settings > Integrations > Omnichannel or WooCommerce Sync. Review the connector selector, queue summary, health banner, order state totals, retry indicators, and audit timestamp before taking manual action. Open the queue tabs and separate New, Linked to POS, Fulfilled, Failed, Conflict, and duplicate rows before intervening. Open the affected order and confirm Woo Order, Customer, Payment, Address, Queue State, Conflict Label, Retry History, and Stock Sync. Use the audit trail after each manual intervention so support can prove what was...
Read article
API API and Webhooks task guide
8.3.1 Review Setup Lists Before New Integrations Open the integration or onboarding setup panel. Review available countries, time zones, currencies, or business categories before creating a new connected workspace. Use the platform lists already provided on screen instead of typing custom values where drop-down choices exist.
Read article
API API and Webhooks task guide
8.2.3 Review Workspace Readiness Open the integration overview or workspace profile panel. Check that the organization status, environment, and required setup items show as ready. Resolve missing approval notes, inactive integrations, or environment mismatches before go-live testing begins.
Read article
API API and Webhooks task guide
8.6.2 Run Manual Pulls and Review Sync Jobs Open the correct WooCommerce connector first and confirm the store name before using any manual action. Use Pull Orders only when support has confirmed that scheduled synchronization did not bring in the expected orders. After the pull completes, review how many orders were queued, skipped as duplicates, or flagged for conflict before leaving the screen. Open the connector history or sync job panel and review start time, completion status, failure notes, and any warning counts tied to the manual pull. Do not repeat a manual pull immediately....
Read article
API API and Webhooks task guide
8.2.1 Sign In and Confirm the Correct Workspace Sign in to the portal using your approved administrator account. If the workspace selector appears, choose the organization you are setting up. Confirm the organization name in the top bar before opening any integration screen. Open Settings > Integrations only after the workspace name is confirmed.
Read article
API API and Webhooks task guide
8.3.3 Turn On Extra Sign-In Protection Open Security from your profile menu. Turn on the available two-step sign-in option approved by your organization. If cashier PIN, device trust, or connected sign-in accounts are shown, review them and remove anything no longer needed. Save the change and test sign-in before closing the setup. PLATFORM WARNING: Do not create production keys or webhook subscriptions from a personal account that will not remain with the support team. Use a named business owner and documented fallback contact for every live integration.
Read article
API API and Webhooks task guide
8.6.4 Use Estimate and Reference Utilities Open the public tools or estimate workspace provided by your environment. Use the available options lists, estimate calculators, PDF preview, or email actions as required by your approved sales or onboarding process. When using holiday reference or country support tools, confirm the country and date range before sharing results.
Read article
API API and Webhooks task guide
8.0.2 What This Module Sends / What This Module Receives DirectionModule handoffOperational meaning ReceivesSecurity and Platform Setup -> IntegrationsWorkspace selection, session policy, device trust, and tenant activation determine whether keys, connectors, and webhooks can operate safely. ReceivesSales, Customers, and Inventory -> IntegrationsCustomer mappings, SKU links, fulfillment branches, and channel-ready master data are prerequisites for clean imports and outbound event delivery. SendsIntegrations -> Sales / POS and WarehouseLinked orders, connector status, and queue outcomes...
Read article