Webhooks in Apple Business Connect 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 Connect haben und jede Umgebung muss von Apple genehmigt sein. Siehe Request API access.
Deinen ersten Webhook erstellen
Wenn du noch nicht bei Apple Business Connect angemeldet bist, melde dich mit einem Benutzerkonto an, das die Rolle eines:einer Administrator:in hat.
Wenn du der:die Administrator:in für mehr als eine Gesellschaft bist, wähle die entsprechende Gesellschaft aus der Gesellschaftsliste
aus.Wähle deine Gesellschaft in der Seitenleiste und dann die API unter dem Gesellschaftsnamen aus.
Wähle
neben „Add Webhook“ 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 „Save“ aus.
Wähle die Taste „Copy“ aus, um das Client-Geheimnis in deine Zwischenablage zu kopieren.
Teile das Client-Geheimnis mit dem:der Administrator:in des Webhooks.
Nachdem der:die Administrator:in bestätigt hat, dass er:sie das Client-Geheimnis erhalten hat, wähle „Done“ aus.
Einen Webhook bearbeiten
Wenn du noch nicht bei Apple Business Connect angemeldet bist, melde dich mit einem Benutzerkonto an, das die Rolle eines:einer Administrator:in hat.
Wenn du der:die Administrator:in für mehr als eine Gesellschaft bist, wähle die entsprechende Gesellschaft aus der Liste
aus.Wähle deine Gesellschaft in der Seitenleiste und dann die API unter dem Gesellschaftsnamen aus.
Wähle
neben „Manage Webhooks“ 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 „Create New Client Secret“ und wähle dann „Create“.
Teile das Client-Geheimnis mit dem:der Administrator:in des Webhooks.
Nachdem der:die Administrator:in bestätigt hat, dass er:sie das Client-Geheimnis erhalten hat, wähle „Done“ 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 „Save“ aus.
Status eines Webhooks anzeigen oder ändern
Wenn du noch nicht bei Apple Business Connect angemeldet bist, melde dich mit einem Benutzerkonto an, das die Rolle eines:einer Administrator:in hat.
Wenn du der:die Administrator:in für mehr als eine Gesellschaft bist, wähle die entsprechende Gesellschaft aus der Liste
aus.Wähle deine Gesellschaft in der Seitenleiste und dann die API unter dem Gesellschaftsnamen aus.
Wähle
neben „Manage Webhooks“ 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
Wenn du noch nicht bei Apple Business Connect angemeldet bist, melde dich mit einem Benutzerkonto an, das die Rolle eines:einer Administrator:in hat.
Wenn du der:die Administrator:in für mehr als eine Gesellschaft bist, wähle die entsprechende Gesellschaft aus der Liste
aus.Wähle deine Gesellschaft in der Seitenleiste und dann die API unter dem Gesellschaftsnamen aus.
Wähle
neben „Manage Webhooks“ und rufe dann die Webhook-Liste auf.Wähle einen Webhook aus, scrolle dann nach unten und wähle „Remove Webhook“.
Wähle „Remove“ und dann „Save“.