Så sätter ni upp event delivery (webhooks) för ett kundkonto

Er endpoint får ett anrop när ett dokument kommer in eller när leveransstatusen ändras. Uppsättningen görs i två steg.

Öppna företaget i partnerdashboarden och gå till Webhooks.
Ange Endpoint URL. Den måste använda HTTPS och svara med en 2xx-kod inom 10 sekunder, annars räknas leveransförsöket som misslyckat.
Välj minst en händelsetyp.
Välj Create signing key om ni vill kunna verifiera att varje leverans kommer från Qvalia. Nyckeln visas en gång, efter att ni sparat, så spara den direkt.
Välj Save and continue.

Händelsetyp

Skickas när

New document

Ett nytt dokument kommer in till företaget

Delivery status changed

Ett dokuments leveransstatus uppdateras

Delivery delayed

Leveransen tar längre tid än väntat

Delivery failed

Ett dokument kunde inte levereras

Välj hur Qvalia autentiserar sig när det anropar er endpoint.

Metod

Så fungerar den

OAuth 2.0 (rekommenderas)

Client credentials grant. Qvalia hämtar en token med kort giltighetstid.

API key

En statisk nyckel som skickas i en header. Headerns namn är valfritt, standard är Authorization.

Basic auth

Användarnamn och lösenord i varje anrop.

Sparade uppgifter visas aldrig igen. Vill ni ändra dem anger ni nya värden, som ersätter de sparade.

För händelser på själva partnerkontot väljer ni kugghjulet uppe till höger och går till Webhooks. Uppsättningen är densamma.

Med event delivery skickar Qvalia dokument- och leveranshändelser till ert eget system när de inträffar. Ni sätter upp det per kundkonto eller för partnerkontot.