Kort svar

Gå til Foreningen → Integrationer, og tryk Opret webhook under Webhooks. Skriv et navn og den adresse, der skal have besked, sæt flueben ved de hændelser, og tryk Opret webhook. Kopiér det secret, der vises.

Før du starter

Sådan gør du

  1. Gå til Foreningen, og tryk Integrationer.
  2. Tryk Opret webhook under Webhooks.
  3. Skriv et Navn, fx “Infoskærm opgang A”.
  4. Skriv adressen i URL (https).
  5. Sæt flueben ved de hændelser, systemet skal have besked om. De står i grupper. Med Vælg alle / ryd vælger eller fjerner du en hel gruppe.
  6. Tryk Opret webhook. Webhookens egen side åbner.
  7. Tryk Kopiér ved secret, og giv det til den, der bygger integrationen. Det vises ikke igen.
  8. Tryk Send test (ping) for at se, om modtageren svarer. Resultatet står øverst og i Leverancelog.

Hvis …

  • … du vil rette navn, adresse eller hændelser: Tryk på webhooken under Webhooks. Ret felterne, og tryk Gem. Hændelserne står i grupper med Vælg alle / ryd, ligesom da du oprettede webhooken.
  • … beskederne skal stoppe et stykke tid: Fjern fluebenet ved Aktiv, og tryk Gem. Webhooken står som Pauset.
  • … webhooken står som Deaktiveret: Årsagen står øverst på siden. Det sker fx, når ingen leveringer er lykkedes i 3 døgn. Bestyrelse og dem, der har fået integrationsadgang, får besked. Ret adressen, sæt flueben ved Aktiv, og tryk Gem.
  • … en besked ikke kom frem: Find den i Leverancelog, og tryk Send igen.
  • … secret skal skiftes: Tryk Rotér secret, og bekræft. Det nye vises én gang. Det gamle virker i 24 timer endnu.
  • … webhooken ikke skal bruges mere: Tryk Slet webhook, og bekræft. Leveranceloggen slettes også.
  • … der står “Grænsen for antal webhooks er nået.”: Slet en webhook, I ikke bruger, eller skriv til NaboPortalen.

Godt at vide

  • En webhook fortæller kun, hvad der skete, hvornår, og hvilke id’er det drejer sig om. Detaljerne henter systemet bagefter med en API-nøgle. Ved hver hændelse står, hvilken rettighed nøglen skal have. Se Sådan opretter du en API-nøgle.
  • Hver besked er signeret med jeres secret, så modtageren kan se, at den kommer fra NaboPortalen. Hvordan signaturen tjekkes, står på webhookens side og på docs.naboportalen.dk.
  • Adresser på private net og localhost bliver afvist.
  • Lykkes en levering ikke, prøver NaboPortalen igen flere gange. I loggen står den som Fejlede, prøver igen og til sidst Opgivet.
  • Status på webhooken kan være Aktiv, Pauset, Fejler eller Deaktiveret.