Webhooks instellen in Apple Business Connect
Een externe partner met API-toegang kan pushmeldingen ontvangen met behulp van een webhook voor statuswijzigingen waarbij verschillende bronnen en gebeurtenissen zijn betrokken. De ontvangen meldingstypen met behulp van webhooks zijn gelijk aan die van de Meldingen-API.
Opmerking: Voordat je een webhook kunt gebruiken, moet je API-toegang hebben tot Apple Business Connect en moet elke omgeving worden goedgekeurd door Apple. Zie API-toegang aanvragen.
Je eerste webhook aanmaken
Als je nog niet bent ingelogd bij Apple Business Connect, log je in als een gebruiker die de rol heeft van beheerder.
Als je voor meer dan één bedrijf de beheerder bent, selecteer je het betreffende bedrijf uit de lijst 'Bedrijf'
.Selecteer je bedrijf in de navigatiekolom en selecteer 'API' onder de bedrijfsnaam.
Selecteer
naast 'Voeg webhook toe' en voer de volgende gegevens in:Informatie
Beschrijving
Webhook
Kan letters, cijfers en symbolen bevatten, behalve de volgende:
; (Puntkomma)
’ (Apostrof)
[ (Vierkant haakje openen)
] (Vierkant haakje sluiten)
< (Kleiner dan-teken)
> (Groter dan-teken)
Teamlid
Een teamlid met de rol 'Beheerder' of 'Ontwikkelaar' waarmee contact wordt opgenomen als de verbinding mislukt
Omgeving
Beperkingen:
Je kunt omgevingen niet meer wijzigen nadat je een webhook hebt ingesteld
Een gebeurtenis kan slechts één keer per omgeving worden gebruikt
Payload-URL
Moet beginnen met https://
Gebeurtenissen
Minimaal één bron of gebeurtenis moet worden geselecteerd
Opmerking: Nadat de webhook-informatie is toegevoegd, wordt een ping verzonden naar de URL om de verbinding te verifiëren.
Selecteer 'Bewaar'.
Selecteer de knop 'Kopieer' om het clientgeheim naar je Klembord te kopiëren.
Deel het clientgeheim met de beheerder van de webhook.
Nadat de beheerder heeft bevestigd dat deze het clientgeheim heeft ontvangen, selecteer je 'Gereed'.
Een webhook wijzigen
Als je nog niet bent ingelogd bij Apple Business Connect, log je in als een gebruiker die de rol heeft van beheerder.
Als je voor meer dan één bedrijf de beheerder bent, selecteer je het betreffende bedrijf uit de lijst 'Bedrijf'
.Selecteer je bedrijf in de navigatiekolom en selecteer 'API' onder de bedrijfsnaam.
Selecteer
naast 'Beheer webhooks' en selecteer een webhook uit de lijst.Je kunt het volgende wijzigen:
De naam van de webhook
De status van de webhook
De naam van een teamlid waarmee contact wordt opgenomen als de verbinding mislukt
De payload-URL
Selecteer indien nodig 'Maak nieuw clientgeheim' en selecteer vervolgens 'Maak'.
Deel het clientgeheim met de beheerder van de webhook.
Nadat de beheerder heeft bevestigd dat deze het clientgeheim heeft ontvangen, selecteer je 'Gereed'.
Selecteer alle bronnen en gebeurtenissen waarover je op de hoogte wilt worden gesteld.
Opmerking: Resources die worden gebruikt in dezelfde webhookomgeving zijn voor slechts één webhook beschikbaar.
Selecteer 'Bewaar'.
De status van een webhook bekijken of wijzigen
Als je nog niet bent ingelogd bij Apple Business Connect, log je in als een gebruiker die de rol heeft van beheerder.
Als je voor meer dan één bedrijf de beheerder bent, selecteer je het betreffende bedrijf uit de lijst 'Bedrijf'
.Selecteer je bedrijf in de navigatiekolom en selecteer 'API' onder de bedrijfsnaam.
Selecteer
naast 'Beheer webhooks' en bekijk de lijst 'Webhook'.Wijzig de status van de webhook om deze in of uit te schakelen.
Als je een webhook uitschakelt, worden er geen meldingen meer naar verzonden.
Een webhook verwijderen
Als je nog niet bent ingelogd bij Apple Business Connect, log je in als een gebruiker die de rol heeft van beheerder.
Als je voor meer dan één bedrijf de beheerder bent, selecteer je het betreffende bedrijf uit de lijst 'Bedrijf'
.Selecteer je bedrijf in de navigatiekolom en selecteer 'API' onder de bedrijfsnaam.
Selecteer
naast 'Beheer webhooks' en bekijk de lijst 'Webhook'.Selecteer een webhook, scrol naar beneden en selecteer 'Verwijder webhook'.
Selecteer 'Verwijder' en vervolgens 'Bewaar'.