Skip to content

REST API v1 · Resource

Integrations

Read each integration’s status, sync it, change its settings and messages, and disconnect it.

API reference · Integrations

Endpoints

Paths are relative to https://fliok.com/api/v1. Each endpoint names the scope and the lowest key role it needs; a key without them gets 403 (see Authentication).

Integrations

7
  • GET/integrationsEvery connector your Integrations page shows — Shopify, WooCommerce, WordPress, HubSpot, Zoho, Google Sheets, Instagram, Razorpay, Meta ads and catalog, Facebook Lead Ads, lead sources, the API — with whether it is connected or needs attention, the account, its last activity and a connectUrl. Never a tokenScope integrations:read · viewer role or higher
  • GET/integrations/{key}One connector with what its dashboard popup shows: settings, counts and recent errors, or the stores and WordPress sites behind it. facebook-lead-ads: the Pages leads come in through, the forms seen, leads in 30 days, the last lead and recent errorsScope integrations:read · viewer role or higher
  • POST/integrations/{key}/syncThe dashboard’s “Sync now” for HubSpot ({ backfill } sends existing leads), Zoho CRM and Google Sheets ({ action }). Same plan gates and allowance as the button; others answer not_syncableScope integrations:manage · admin role or higher
  • PATCH/integrations/{key}/settingsChange what a person can change in the connector’s popup — HubSpot, Zoho CRM, Google Sheets streams. Strict: tokens and secrets are never acceptedScope integrations:manage · admin role or higher
  • GET/integrations/{key}/messagesshopify / woocommerce: the store’s WhatsApp messages — order events, COD confirmation, abandoned carts, order statuses, tracking, refunds, payment reminders, reviews, back in stock, the team’s alert — with each template and mapping, and the approved templates to choose fromScope integrations:read · viewer role or higher
  • PATCH/integrations/{key}/messagesChange a store’s WhatsApp messages, only what is sent. Approved templates only; turning anything on follows the plan, as in the dashboardScope integrations:manage · admin role or higher
  • DELETE/integrations/{key}Disconnect HubSpot, Zoho, Google Sheets, Shopify, WooCommerce, a WordPress site (?account=), Instagram, Razorpay, WhatsApp Pay, the Conversions API or the Meta ad account — as the dashboard does, audit-logged. Connecting stays in the dashboardScope integrations:manage · admin role or higher

Rate limits

These endpoints have no row of their own in the rate-limit table.

Every limit, the RateLimit-* headers and what to do on a 429: Rate limits.