Indstil webhooks i Apple Business Connect
En tredjepartspartner med API-adgang kan modtage push-meddelelser via en webhook om tilstandsændringer, der involverer forskellige ressourcer og begivenheder. De meddelelsestyper, der modtages via webhooks, er ligestillet med meddelelser fra meddelelses-API’en.
Bemærk: Før du kan bruge en webhook, skal du have API-adgang til Apple Business Connect, og de enkelte miljøer skal godkendes af Apple. Se Anmod om API-adgang.
Opret din første webhook
Hvis du ikke allerede er logget ind på Apple Business Connect, skal du logge ind med en bruger, der har rollen som administrator.
Hvis du er administrator for mere end ét selskab, skal du vælge det relevante selskab på selskabslisten
.Vælg dit selskab i indholdsoversigten, og vælg derefter API under selskabsnavnet.
Vælg
ud for Tilføj webhook, og angiv derefter følgende oplysninger:Oplysninger
Beskrivelse
Webhook
Kan indeholde bogstaver, tal og symboler, med undtagelse af følgende:
; (semikolon)
’ (tegnsætningsapostrof)
[ (venstre firkantet parentes)
] (højre firkantet parentes)
< (mindre end-tegn)
> (større end-tegn)
Teammedlem
Et teammedlem med rolle som Administrator eller Udvikler, der skal kontaktes, hvis der opstår forbindelsesfejl
Miljø
Begrænsninger:
Det er ikke muligt at skifte miljø, når du har indstillet en webhook
En aktivitet kan kun bruges én gang pr. miljø
URL for nyttelasten
Skal starte med https://
Aktiviteter
Der skal vælges mindst én ressource eller en anden aktivitet
Bemærk: Når webhook-oplysningerne er tilføjet, pinges URL-adressen for at bekræfte forbindelsen.
Vælg Gem.
Vælg knappen Kopier for at kopiere klienthemmeligheden til din udklipsholder.
Videregiv klienthemmeligheden til administratoren for webhooken.
Når administratoren bekræfter, a denne har modtaget klienthemmeligheden, skal du vælge OK.
Rediger en webhook
Hvis du ikke allerede er logget ind på Apple Business Connect, skal du logge ind med en bruger, der har rollen som administrator.
Hvis du er administrator for mere end ét selskab, skal du vælge det relevante selskab på selskabslisten
.Vælg dit selskab i indholdsoversigten, og vælg derefter API under selskabsnavnet.
Vælg
ud for Administrer webhooks, og vælg derefter en webhook på listen.Du kan ændre følgende:
Navnet på webhooken
Statussen for webhooken
Navnet på et teammedlem, der skal kontaktes, hvis der opstår forbindelsesfejl
URL for nyttelasten
Vælg om nødvendigt Opret ny klienthemmelighed, og vælg derefter Opret.
Videregiv klienthemmeligheden til administratoren for webhooken.
Når administratoren bekræfter, a denne har modtaget klienthemmeligheden, skal du vælge OK.
Vælg alle de ressourcer og begivenheder, du vil modtage meddelelser om.
Bemærk: Ressourcer, der anvendes i samme webhook-miljø, er ikke tilgængelige for mere end én webhook.
Vælg Gem.
Vis eller ændr statussen for en webhook
Hvis du ikke allerede er logget ind på Apple Business Connect, skal du logge ind med en bruger, der har rollen som administrator.
Hvis du er administrator for mere end ét selskab, skal du vælge det relevante selskab på selskabslisten
.Vælg dit selskab i indholdsoversigten, og vælg derefter API under selskabsnavnet.
Vælg
ud for Administrer webhooks, og se derefter webhooklisten.Ændr statussen for webhooken for at slå det til eller fra.
Hvis webhooken slås fra, kan der ikke sendes meddelelser til den.
Fjern en webhook
Hvis du ikke allerede er logget ind på Apple Business Connect, skal du logge ind med en bruger, der har rollen som administrator.
Hvis du er administrator for mere end ét selskab, skal du vælge det relevante selskab på selskabslisten
.Vælg dit selskab i indholdsoversigten, og vælg derefter API under selskabsnavnet.
Vælg
ud for Administrer webhooks, og se derefter webhooklisten.Vælg en webhook, og rul derefter ned, og vælg Fjern webhook.
Vælg Fjern, og vælg derefter Gem.