Webhooks in Apple Business einrichten
Ein Drittanbieter‑Partner mit API-Zugang kann über einen Webhook Push-Benachrichtigungen für Statusänderungen erhalten, die verschiedene Ressourcen und Ereignisse betreffen. Die Benachrichtigungsarten, die über Webhooks empfangen werden, entsprechen denen der Benachrichtigungs-API.
Hinweis: Bevor du einen Webhook verwenden kannst, musst du API-Zugang zu Apple Business haben und jede Umgebung muss von Apple genehmigt sein. Siehe API-Zugriff anfordern.
Deinen ersten Webhook erstellen
Melde dich in Apple Business mit einem Benutzeraccount an, der über die Rolle „Administrator:in der Organisation“ verfügt.
Informationen zu Rollen und Zugriffsrechten findest du unter Einführung in Rollen und Zugriffsrechte.
Wähle in deinem Browser „Einstellungen“ > „Partnerzugriff“ aus.
Wähle „API“ aus.
Wähle
neben „Webhook hinzufügen“ aus und gib dann die folgenden Informationen ein:Angaben
Beschreibung
Webhook
Kann Buchstaben, Zahlen und Symbole enthalten, außer den folgenden:
; (Semikolon)
’ (Interpunktionsapostroph)
[ (Linke eckige Klammer)
] (Rechte eckige Klammer)
< (Kleiner-als-Zeichen)
> (Größer-als-Zeichen)
Teammitglied
Ein Teammitglied mit der Rolle des:der Administrator:in oder Entwickler:in, das kontaktiert wird, wenn die Verbindung fehlschlägt
Umgebung
Beschränkungen:
Du kannst die Umgebung nicht mehr ändern, nachdem du einen Webhook eingerichtet hast.
Ein Ereignis kann nur einmal pro Umgebung verwendet werden.
Payload-URL
Muss mit https:// beginnen
Ereignisse
Mindestens eine Ressource oder ein anderes Ereignis muss ausgewählt werden.
Hinweis: Nachdem die Webhook-Informationen hinzugefügt wurden, wird ein Ping an die URL gesendet, um die Verbindung zu bestätigen.
Wähle „Sichern“ aus.
Wähle „Kopieren“ aus, um das Client-Secret in deine Zwischenablage zu kopieren.
Teile das Client-Secret mit dem:der Administrator:in des Webhooks.
Nachdem der:die Administrator:in bestätigt hat, dass er:sie das Client-Secret erhalten hat, wähle „Fertig“ aus.
Einen Webhook bearbeiten
Melde dich in Apple Business mit einem Benutzeraccount an, der über die Rolle „Administrator:in der Organisation“ verfügt.
Informationen zu Rollen und Zugriffsrechten findest du unter Einführung in Rollen und Zugriffsrechte.
Wähle in deinem Browser „Einstellungen“ > „Partnerzugriff“ aus.
Wähle „API“ aus.
Wähle
neben „Webhooks verwalten“ und dann einen Webhook aus der Liste aus.Du kannst Folgendes ändern:
Der Name des Webhooks
Der Status des Webhooks
Der Name eines Teammitglieds, das kontaktiert wird, falls die Verbindung fehlschlägt
Die URL der Payload
Falls nötig, wähle „Neues Client-Secret erstellen“ und dann „Erstellen“.
Teile das Client-Secret mit dem:der Administrator:in des Webhooks.
Nachdem der:die Administrator:in bestätigt hat, dass er:sie das Client-Secret erhalten hat, wähle „Fertig“ aus.
Wähle alle Ressourcen und Ereignisse aus, über die du benachrichtigt werden möchtest.
Hinweis: Ressourcen, die in der gleichen Webhook-Umgebung verwendet werden, sind nur für einen Webhook verfügbar.
Wähle „Sichern“ aus.
Status eines Webhooks anzeigen oder ändern
Melde dich in Apple Business mit einem Benutzeraccount an, der über die Rolle „Administrator:in der Organisation“ verfügt.
Informationen zu Rollen und Zugriffsrechten findest du unter Einführung in Rollen und Zugriffsrechte.
Wähle in deinem Browser „Einstellungen“ > „Partnerzugriff“ aus.
Wähle „API“ aus.
Wähle
neben „Webhooks verwalten“ und rufe dann die Webhook-Liste auf.Ändere den Status des Webhooks, um ihn ein- oder auszuschalten.
Wenn du einen Webhook deaktivierst, werden keine Benachrichtigungen mehr an ihn zugestellt.
Einen Webhook entfernen
Melde dich in Apple Business mit einem Benutzeraccount an, der über die Rolle „Administrator:in der Organisation“ verfügt.
Informationen zu Rollen und Zugriffsrechten findest du unter Einführung in Rollen und Zugriffsrechte.
Wähle in deinem Browser „Einstellungen“ > „Partnerzugriff“ aus.
Wähle „API“ aus.
Wähle
neben „Webhooks verwalten“ und rufe dann die Webhook-Liste auf.Wähle einen Webhook aus, scrolle dann nach unten und wähle „Webhook entfernen“.
Wähle „Entfernen“ und dann „Sichern“.