Zeyora Documentation

Zeyora integrations documentation

A practical guide for connecting websites, external systems, finance workflows and webchat to Zeyora.

How Zeyora integrations should be planned

A good integration starts with the business workflow, not the endpoint. Before sending data into Zeyora, decide which module owns the record, which user should be responsible, which status or source should be applied, and what should happen after the data arrives.

Common integration patterns

Website lead forms

Use this when a public website, landing page or campaign form should create a CRM lead. The form should collect enough information for the sales team to act: name, phone, email, company, message, source, service interest and preferred follow-up date.

E-commerce and order integrations

Use order and product endpoints when an external store needs to send orders, products or item cost data to Zeyora. This is useful for trading and distribution teams that want stock, sales and customer information closer together.

Finance integrations

Use invoice, credit note and receipt endpoints when another system owns the transaction trigger but Zeyora should hold the finance record. Always sync customers and item masters first where IDs are required.

Webchat and Omni Inbox

Use the webchat endpoints when a public widget should start a visitor session, send messages into Omni Inbox and poll for replies. The widget key identifies the public channel and can be restricted by allowed domains.

Implementation checklist

  • Create or request API credentials from the Zeyora admin area.
  • Confirm the target tenant, responsible user, lead status, source, service and required fields.
  • Send test payloads to a staging or test tenant before using production data.
  • Log every request and response in your own integration layer.
  • Handle `result`, `error`, `status`, `pending`, and validation messages gracefully.