SimpliServDocs

Connect ZIR Online

Turn ZIR Online repair tasks into workshop jobs: store credentials, register the webhook, accept RMAs, report progress, send cost estimates and repair invoices.

Open the ZIR connector in SimpliServ · Open workshop jobs

ZIR Online is the platform retailers, insurers and suppliers use to send repairs to authorised service centers. With this connector your workshop acts as a service center: every ZIR task arrives as a workshop job in SimpliServ, and everything the sender sees afterwards — intake decision, progress, cost estimate, invoice, answers to questions — is sent back from SimpliServ.

The point is that you no longer need the ZIR portal day to day. Exactly one step stays there: registering the webhook once.

Requirements

  • A ZIR account as a service center with access to the Externals API v1.
  • Client ID and client secret from the ZIR developer portal (OAuth 2.0 client credentials).
  • The country your service center is registered in at ZIR — ZIR keeps tasks per country.
  • In SimpliServ the view settings permission (admin.settings.view), plus admin.settings.update to save.

Customer data stays locked until a contract exists. ZIR releases the end customer's name, address and phone number only to service centers that signed a data processing agreement. Without it the task still arrives — just without contact details.

Set up the connection

Open the connector

Go to Administration → Organisation → Connectors and open the ZIR Online tile. The fields sit in the Configuration tab.

Enter the credentials

Fill in client ID, client secret and your country. The secret is stored encrypted and never shown again — afterwards you only see that one is stored. The client ID cannot be changed later; for a different account, disconnect and connect again.

Save

Connect fetches a token from ZIR right away. On success the status reads Connected. On failure the connection stays but flips to Disconnected and shows ZIR's message — usually a typo in the secret.

Use Test connection to check again at any time.

Register the webhook in ZIR

Without a webhook SimpliServ only learns about new tasks on the hourly sweep. The URL sits in the Webhook block and already carries a secret — ZIR does not sign its deliveries, so the token in the address is the key.

Copy the URL

Shape: https://…/api/v1/webhooks/zir/<your-slug>/<token>. Treat it like a password.

Register it in the ZIR portal

Add it there as the webhook target. The relevant events are task.rma_request, task.message, transfer.rma_request, transfer.invoiced and waybill.announcement.

Check delivery

SimpliServ reads the webhooks registered at ZIR and reports in the same block whether ZIR delivers to this address, whether the webhook is disabled there, or whether it was never created.

Rotating the token invalidates the old address immediately. Update it in the ZIR portal or no events arrive.

Choose the automation

The Automation block decides what happens on its own and what you trigger yourself.

SwitchDefaultEffect
Import tasks automaticallyonEvery new ZIR task opens a workshop job right away.
Import attachmentsonPhotos and documents from ZIR land in the job's files.
Fetch customer dataoffPulls the end customer's contact details — only with a signed agreement.
Accept RMA automaticallyoffAccepts every imported task unchecked. Otherwise the workshop decides.
Report status automaticallyonProgress on the workshop job becomes a ZIR status notification.
Send cost estimate automaticallyonAs soon as the job has an estimate it goes to ZIR as a PDF.
Send repair invoice automaticallyoffTransfers the job's invoice as the repair invoice.
Sync questionsonSender messages show up on the job and can be answered there.

Working on a job

When a job came from ZIR, its detail page carries the ZIR card — with reference, store, task type, warranty type, RMA number and the status reported last.

Accept or decline

While the intake decision is open, both routes are available:

  • Accept — optionally with your own RMA number. Leave the field empty and SimpliServ uses the job's scan code (CR-123), so the workshop label and the RMA number carry the same string.
  • Decline — with a reason: not bought here, wrong RMA procedure, wrong workshop, not covered by warranty, or insufficient data. For the last one you must tick what is missing (serial number, proof of purchase, fault description, accessories) — without it ZIR rejects the decline. The workshop job is cancelled afterwards.

Report progress

With automation on, SimpliServ reports progress itself as the job moves:

State of the workshop jobReported to ZIR
imported, nothing elseReceived at workshop
estimate created, no order yetCost estimate created
order createdRepair started
SLA pausedRepair paused
order status "finished"Repair finished
ready for pickup, delivery note delivered, or case closedShipped back

The same notification is never sent twice in a row — the sender would otherwise see duplicate entries in their repair history. The remaining notifications — spare parts ordered, repair continued, retailer feedback requested, credit note created — you trigger from the card, optionally with a note and attached files.

Send documents

  • Send cost estimate — renders the estimate PDF and transfers it; ZIR shows it to the sender for approval. The matching status notification goes with it.
  • Send repair invoice — transfers the job's invoice with its net amount. ZIR settles the tax on their side.
  • Report serial number — sends back the serial or IMEI actually found on the device when the task carried a wrong one.

Questions

Questions from the sender appear in the card's message thread. You answer right below — either as a new message or as a reply to a specific question. Files already on the job can be attached (PDF, JPEG, PNG, CSV).

Logistics

Where the information exists, the card shows where to ship back, the target warehouse location at ZIR, and the announced waybill with transporter and date. When goods arrive as a transfer, you accept it here as well.

If the device arrives before its webhook, create the workshop job as usual and enter the task reference in the ZIR card (e.g. X123-1234567-R). SimpliServ fetches the task and attaches it — without opening a second case.

Documents from ZIR

Attachments from ZIR — photos, proofs of purchase, fault reports — sit in the workshop job's Files card, tagged ZIR. The same goes for files attached to a question. In the other direction, every file on the job is a candidate attachment for a status notification or an answer.

Finding the work

ZIR intake

Its own view in workshop jobs listing every task still waiting on an accept or decline, with a counter. It only appears when ZIR is connected.

ZIR badge

Jobs from ZIR carry a badge in the list; open intake decisions show in red and unread questions are counted.

Open ZIR intake

Supplier invoice to ZIR

Finished ZIR repairs can be billed in one batch: in the connector you pick the jobs, give an invoice number and transfer them as a single supplier invoice. Every line needs brand, serial number and EAN — a job missing one of them is left out. Billed jobs remember their invoice number and cannot be picked again.

When a delivery goes missing

Webhooks are not guaranteed. SimpliServ therefore sweeps the open ZIR tasks every hour and imports anything that has no workshop job yet — repairs as well as returns. A dropped delivery costs time, never a job. To pull a single task immediately, use Fetch a task manually in the connector.

Events delivered more than once are processed only once. The contents of an event are always re-read from ZIR, never taken from the delivery itself.

Disconnecting

Disconnect removes the connection together with every link between workshop jobs and ZIR tasks. The workshop jobs themselves keep all their files and messages; new tasks stop arriving.

How is this guide?

On this page