Webhooks maken

U kunt webhooks maken in Genetec ClearID™ om te integreren met API's voor oplossingen van derden, zodat u geïnteresseerde partijen op de hoogte kunt stellen wanneer zich specifieke gebeurtenissen voordoen.

1. Klik op de startpagina op Beheer > Webhooks .
2. Klik op Webhook toevoegen.

   

3. Vul in het gedeelte Algemeen de velden in:
   1. (Optioneel) Verplaats de schuifregelaar Ingeschakeld om de webhook in of uit te schakelen.
      OPMERKING:

      Als de webhook is uitgeschakeld, vindt de HTTP-callback niet plaats.
   2. Voer in het veld Naam een betekenisvolle naam in, zodat u uw webhook later gemakkelijk kunt identificeren.
      Bijvoorbeeld, Identiteit bijgewerkt of Identiteitsaanvragen aangemaakt webhook , enzovoort.
   3. Voer in het veld Beschrijving een beschrijving in die het doel van de webhook beschrijft.
      Bijvoorbeeld waar de webhook voor is en welke API (programma of applicatie) deze meldt wanneer er gebeurtenissen plaatsvinden.
4. Vul in het gedeelte Webhookdetails de velden in:
   1. Voer een geldige HTTPS:// URL in voor uw API (programma of applicatie).
      URL's kunnen als volgt poorten en queryparameters bevatten:

      • Voorbeeld 1: https://my-api.com/identityupdatedendpoint
      • Voorbeeld 2: https://my-api.com:8080/identity-updated-endpoint?my-query-param=123

      Deze URL wordt gebruikt om de webhookgebeurtenismelding door te sturen naar de relevante API (programma of applicatie) van derden.

      OPMERKING:

      Uw organisatie is verantwoordelijk voor het verstrekken van de URL waarnaar u de meldingen van de webhookgebeurtenis wilt doorsturen.
   2. (Optioneel) Voer het geheim (app-sleutel) in als de API van derden dit vereist.
      Het geheim (app-sleutel) wordt gebruikt voor het verifiëren van de communicatie tussen de ClearID-webhook en de API van derden van uw organisatie.
5. (Optioneel) Vul in het gedeelte Extra kopteksten de velden in:
   Extra aangepaste HTTP-kopteksten kunnen worden toegevoegd aan het HTTP-callbackverzoek, zodat ze kunnen worden gebruikt door de API van derden aan de gebruikerskant van de integratie.

   OPMERKING:

   Als u een ongeldige of gereserveerde koptekst invoert, wordt het volgende bericht weergegeven : de ingediende HTTP-verzoekkoptekst is ongeldig of wordt misbruikt.

   

   1. Voer de koptekstparameter Naam in.
      Als er bijvoorbeeld één gebeurtenis afkomstig is van meerdere bronnen, kunnen extra HTTP-aanvraagkopteksten worden gebruikt om aan te geven waar de gebeurtenis vandaan komt (ClearID of externe API).

      

   2. Voer de koptekstparameter Waarde in.
   3. (Optioneel) Klik op Koptekst toevoegen om indien nodig extra HTTP-verzoekkopteksten toe te voegen.
      Bijvoorbeeld als uw API een specifieke set kopteksten verwacht of vereist (Host, Oorsprong, Taal, enzovoort).
   4. (Optioneel) Klik op om kopteksten te verwijderen die niet langer nodig zijn.
6. Configureer in het gedeelte Gebeurtenis de gewenste instellingen:
   1. Selecteer in de lijst Gebeurtenis een gebeurtenis waarnaar u deze webhook wilt laten luisteren.
   2. Klik op Schema downloaden en volg de aanwijzingen van uw browser.
      BESTE PRAKTIJKEN:

      Gebruik de gedownloade schema-informatie om inzicht te krijgen in de gegevensstructuur van de gebeurtenissen, zodat deze correct kunnen worden opgehaald en verwerkt aan de gebruikerskant van de integratie.

      In het volgende voorbeeld ziet u een uittreksel uit een schema-identitycreated.json bestand:

      {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "IdentityDeletedCallbackModel",
        "type": "object",
        "additionalProperties": false,
        "required": [
          "AccountId",
          "IdentityId",
          "DeletedBy",
          "DeletionDateUtc"
        ],
        "properties": {
          "AccountId": {
            "type": "string",
            "description": "The account id for which this identity is member of.",
            "minLength": 1
          },
          "IdentityId": {
            "type": "string",
            "description": "A unique id to identify the identity.",
            "minLength": 1
          },
          "ExternalId": {
            "type": [
              "null",
              "string"
            ],
            "description": "External ID"
          },
          "Ordinal": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Commit ordinal in the storage.",
            "format": "int64"
          },
          "Email": {
            "type": [
              "null",
              "string"
            ],

7. Klik op Opslaan.