Konfigurer webhooks i Apple Business Connect
En tredjepartspartner med API-tilgang kan motta push-varslinger med en webhook for tilstandsendringer som involverer ulike ressurser og hendelser. Varslingstypene som mottas med webhooks er de samme som mottas fra varslinger-API-en.
Merk: Før du kan bruke en webhook, må du ha API-tilgang til Apple Business Connect og hvert miljø må være godkjent av Apple. Les Be om API-tilgang.
Opprett din første webhook
Hvis du ikke allerede er logget på Apple Business Connect, kan du logge på med en bruker som har en administratorrolle.
Hvis du er administrator for mer enn ett selskap, velger du det aktuelle selskapet fra listen over selskaper
.Velg selskapet ditt i sidepanelet, og velg deretter API under selskapsnavnet.
Velg
ved siden av Legg til webhook. Deretter skriver du inn følgende informasjon:Informasjon
Beskrivelse
Webhook
Kan inneholde bokstaver, siffer og symboler, med unntak av følgende:
; (semikolon)
’ (tegnsettingsapostrofe)
[ (venstre hakeparentes)
] (høyre hakeparentes)
< (mindre enn-tegn)
> (større enn-tegn)
Teammedlem
Et teammedlem med rollen Administrator eller Utvikler som blir kontaktet hvis tilkoblingen mislykkes
Miljø
Restriksjoner:
Du kan ikke bytte miljø etter at du har konfigurert en webhook
En hendelse kan kun brukes én gang per miljø
Nettadresse for nyttelast
Må starte med https://
Hendelser
Minst en ressurs eller annen hendelse må være valgt
Merk: Når webhook-informasjon er lagt til, sendes et ping til nettadressen for å bekrefte tilkoblingen.
Velg Lagre.
Velg Kopier-knappen for å kopiere klienthemmeligheten til utklippstavlen.
Del klienthemmeligheten med administratoren for webhooken.
Når administratoren har bekreftet at vedkommende har mottatt klienthemmeligheten, velger du Ferdig.
Rediger en webhook
Hvis du ikke allerede er logget på Apple Business Connect, kan du logge på med en bruker som har en administratorrolle.
Hvis du er administrator for mer enn ett selskap, velger du det aktuelle selskapet fra listen over selskaper
.Velg selskapet ditt i sidepanelet, og velg deretter API under selskapsnavnet.
Velg
ved siden av Administrer webhooks og velg en webhook fra listen.Du kan endre følgende:
Navnet på webhooken
Statusen til webhooken
Navnet på et teammedlem som kontaktes hvis tilkoblingen blir avbrutt
Nettadressen for nyttelasten
Hvis det er nødvendig, velger du Opprett ny klienthemmelighet og deretter Opprett.
Del klienthemmeligheten med administratoren for webhooken.
Når administratoren har bekreftet at vedkommende har mottatt klienthemmeligheten, velger du Ferdig.
Velg alle ressursene og hendelsene du vil varsles om.
Merk: Ressurser som brukes i samme webhook-miljø er ikke tilgjengelige for mer enn én webhook.
Velg Lagre.
Se eller endre statusen til en webhook
Hvis du ikke allerede er logget på Apple Business Connect, kan du logge på med en bruker som har en administratorrolle.
Hvis du er administrator for mer enn ett selskap, velger du det aktuelle selskapet fra listen over selskaper
.Velg selskapet ditt i sidepanelet, og velg deretter API under selskapsnavnet.
Velg
ved siden av Administrer webhooks og se på webhook-listen.Endre statusen for en webhook for å slå den på eller av.
Hvis du slår av en webhook, leveres ikke varslinger til den.
Fjern en webhook
Hvis du ikke allerede er logget på Apple Business Connect, kan du logge på med en bruker som har en administratorrolle.
Hvis du er administrator for mer enn ett selskap, velger du det aktuelle selskapet fra listen over selskaper
.Velg selskapet ditt i sidepanelet, og velg deretter API under selskapsnavnet.
Velg
ved siden av Administrer webhooks og se på webhook-listen.Velg en webhook. Deretter ruller du ned og velger Fjern webhook.
Velg Fjern og deretter Arkiver.