Vil du holde dine eksterne systemer opdateret med den nyeste information fra OnlineFundraising? Så skal du oprette et webhook i Webhooks-modulet, som du kan få en introduktion til her. Guiden her beskriver trin-for-trin, hvordan du opretter et webhook – og hvilke informationer, du skal bruge.
1. Gå til Webhooks-modulet
Klik på Webhooks i hovedmenuen til venstre i OnlineFundraising for at åbne modulet.
2. Opret et nyt webhook endpoint
Klik på Add new i venstre side for at oprette et nyt webhook endpoint, som kan håndtere de hændelser, du ønsker at overvåge.
3. Udfyld informationerne for dit webhook
Dernæst åbner følgende vindue med informationer, du skal udfylde.
Udfyld følgende felter:
- Description: Tilføj en kort beskrivelse af dit webhook, så det er nemmere at identificere senere.
- Endpoint: Indtast den URL, hvor data skal sendes – sørg for, at den er korrekt og klar til at modtage data.
-
API: Vælg, om webhooks skal tilknyttes Payment API eller Dataset API:
- Payment API: Vælg denne mulighed, hvis du ønsker at overvåge betalingsrelaterede hændelser, f.eks. aftaler og transaktioner.
- Dataset API: Vælg denne mulighed, hvis du vil overvåge datasets.
-
Events: Vælg de hændelser, du vil overvåge. Du kan vælge Select all for at abonnere på alle begivenheder eller udvælge specifikke hændelser:
Hvis du har valgt Payment API, kan du vælge mellem følgende hændelser:
- Created: Når en ny enhed oprettes.
- Updated: Når en eksisterende enhed ændres.
- Archived: Når en enhed arkiveres.
- Merged: Når to enheder samles.
- Activated: Når en enhed aktiveres.
- Cancelled: Når en enhed annulleres.
- Restarted: Når en enhed genstartes.
- Expired: Når en enhed udløber.
- On hold: Når en enhed sættes på pause.
- Failed: Når en enhed mislykkes.
- Rejected: Når en enhed afvises.
- Session expired: Når en session slutter.
- Charged: Når en betaling gennemføres.
-
Refunded: Når en betaling tilbagebetales.
For hver hændelse kan du vælge de specifikke enheder, du ønsker at holde øje med:
-
- Contact: Overvåg oprettelse eller ændringer ved kontakter.
- Agreement: Hold styr på ændringer i agreements.
- Subscription: Følg med i ændringer til subscriptions.
- Payment method: Se ændringer i betalingsmetoder.
- Payment: Overvåg betalingstransaktioner.
-
Addon: Hold øje med ændringer relateret til tilføjelser.
Eksempel: Hvis du ønsker at dit webhook skal opdatere et eksternt system, når en ny kontakt oprettes, kan du vælge Created og derefter markere Contact.
Hvis du har valgt Dataset API, kan du vælge
-
- Created: Når en ny dataset-enhed oprettes
- Updated: Når en eksisterende dataset-enhed ændres
4. Gem dit webhook
Når du har indstillet alle felter, klikker du på Save øverst til højre for at gemme og aktivere dit nye webhook endpoint.
Læs evt. guiden "Sådan redigerer du et webhook", hvis du senere hen ønsker at tilpasse dine webhook-indstillinger.