Introductie
De API’s en webhooks van idloom bieden krachtige tools voor het automatiseren van workflows en het integreren met externe systemen. Met behulp van API’s kunnen gebruikers eenvoudig data synchroniseren tussen idloom en andere software, wat zorgt voor een efficiënter beheer van evenementen. Webhooks maken real-time triggers mogelijk, waardoor specifieke acties of meldingen automatisch plaatsvinden wanneer bepaalde gebeurtenissen zich voordoen op het platform.
Deze functies zijn ideaal voor eventorganisatoren, ontwikkelaars en IT-beheerders die de mogelijkheden van het platform willen uitbreiden en optimaliseren.
Aan de slag
Bij idloom geloven we sterk in het eigenaarschap van gegevens; de data die je verzamelt, is volledig van jou. Daarom zijn onze integratiemodules beschikbaar vanaf de light-versie, zodat je idloom naadloos in je software-ecosysteem kunt integreren, of je nu een frequente of incidentele gebruiker bent.
Ga naar het integratiesectie van de Events App en start een nieuwe integratie. Je kunt kiezen uit een set vooraf gedefinieerde native integraties of er zelf een op maat maken, wat we hieronder verder zullen bespreken.
Aangepaste Integratie
De integratie bestaat uit vier kernonderdelen:
- Basisinstellingen: Definieer de naam, het profiel dat het gebruikt, en de API Key indien nodig.
- Automatische Configuratie: Wanneer je je inschrijvingsformulieren koppelt aan een andere applicatie, moet je een vaste structuur instellen. Dit zorgt voor consistente velden in alle inschrijvingsformulieren, waardoor je gestructureerde gegevens naar de externe applicatie kunt verzenden. Dit wordt beheerd via de Geavanceerde Instellingen van het Inschrijvingsformulier.
- Veldmapping: Pas de gegevens aan om compatibiliteit met de externe app te garanderen via de API veldtoewijzing.
- Webhooks: Configureer webhooks voor realtime gegevensoverdracht en koppel ze aan idloom-triggers voor automatisering.
Profielgegevens Toegang Inschakelen
Met de integratie die je bouwt, kun je via API’s evenementen- en registratiegegevens benaderen of webhooks activeren. Om dit te doen, moet je het relevante profiel koppelen aan de integratie en API-toegang inschakelen.
Voor betere beveiliging van gegevens raden we aan om de blootstelling van profielgegevens te minimaliseren:
- Maak aparte integraties voor toegang tot verschillende profielen.
- Schakel API-toegang alleen in als het nodig is.
- Genereer een nieuwe API-sleutel bij de overgang naar productie en vernieuw deze regelmatig (bv. elke 6-12 maanden).
Webhooks Aanmaken en Beheren
Begin met het toevoegen van een webhook en selecteer de trigger die je wilt activeren:
- event.create, event.update, event.delete, event.manual: Deze triggers sturen een REST-gebeurtenis payload naar je endpoint, met hetzelfde formaat als de API Get Events-methode. De handmatige trigger voegt een nieuwe optie toe in de event-acties.
- guest.create, guest.update, guest.delete, guest.manual: Deze triggers sturen een REST-deelnemer payload naar je endpoint, met hetzelfde formaat als de API Get Attendees-methode. De handmatige trigger voegt een optie toe in de deelnemers-acties.
Vervolgens kun je de naam van de webhook, de URL voor het verzenden van de payload en de HTTP-methode (GET, POST, PUT, DELETE, PATCH) opgeven. Als je een handmatige trigger hebt geselecteerd, wordt de webhooknaam het label voor de nieuwe functie in het menu.
Je kunt ook aanvraagheaders configureren, zoals Bearer Tokens of andere beveiligingsinstellingen.
Wil je de webhook beperken tot specifieke evenementen, voer dan hun UID-waarden in, gescheiden door komma’s. Deze informatie vind je in de sectie Geek > Analytics & Tracking van je evenementinstellingen.
Webhooks voor Integraties Activeren in Profielen
Je bent er bijna. Hoewel het verbinden van een integratie met profielen en het inschakelen van API-toegang automatisch toegang geeft tot alle profielen via API-oproepen, geldt dit niet voor webhooks.
Om webhooks voor een specifieke integratie te activeren, ga je naar Events Profiles, selecteer je een profiel, en navigeer naar Geek > Integrations. Activeer daar de gewenste integratie. Let erop dat slechts één integratie per profiel tegelijk actief kan zijn.
Overschrijven van de Standaardintegratie van een Profiel voor een Specifiek Evenement
Het goede nieuws is dat, ongeacht de geactiveerde webhooks voor een profiel, je deze kunt overschrijven voor een specifiek evenement. Ga simpelweg naar Geek > Integrations in de evenementinstellingen, kies de gewenste integratie, pas eventueel de veldmappings aan, en activeer webhooks wanneer een registratie betaald is.
Meer Aanpassing Nodig?
Als je extra verwerking of validatie nodig hebt voordat de payload wordt verzonden, of als je verbeterde beveiliging via two-way SSL wilt, neem dan contact op met je accountmanager. Zij zullen je verzoek doorgeven aan ons technische team.
Wij zetten ons in om de best mogelijke documentatie te bieden, zelfs voor technische inhoud. Heb je vragen of suggesties, aarzel dan niet om contact met ons op te nemen. Jouw feedback helpt ons om deze gebruikershandleiding en de FAQ-sectie te verbeteren.
Veel plezier!
Het idloom.events-team