Set up Webhooks in Apple Business Connect
A Third-Party Partner with API access can receive push notifications using a Webhook for state changes that involve different resources and events. The notification types received using Webhooks are in parity with those from the Notifications API.
Note: Before you can use a Webhook, you need to have API access to Apple Business Connect and each environment needs to be approved by Apple. See Request API access.
Create your first Webhook
If you’re not already signed in to Apple Business Connect, sign in with a user who has the role of Administrator.
If you’re the Administrator for more than one company, select the appropriate company from the Company list
.Select your company in the sidebar, then select API below the company name.
Select
next to Add Webhook, then enter the following information:Information
Description
Webhook
Can contain letters, numbers, and symbols, except the following:
; (Semicolon)
’ (Punctuation apostrophe)
[ (Left Square Bracket)
] (Right Square Bracket)
< (Less-than sign)
> (Greater-than sign)
Team member
A team member with the role of Administrator or Developer who is contacted in case the connection fails
Environment
Restrictions:
You can’t change environments after you set up a Webhook
An event can be used only once per environment
Payload URL
Needs to start with https://
Events
At least one resource or other event needs to be selected
Note: After the Webhook information is added, a ping is sent to the URL to verify the connection.
Select Save.
Select the Copy button to copy the client secret to your Clipboard.
Share the client secret with the administrator of the Webhook.
After the administrator has confirmed they received the client secret, select Done.
Edit a Webhook
If you’re not already signed in to Apple Business Connect, sign in with a user who has the role of Administrator.
If you’re the Administrator for more than one company, select the appropriate company from the Company list
.Select your company in the sidebar, then select API below the company name.
Select
next to Manage Webhooks, then select a Webhook from the list.You can change the following:
The name of the Webhook
The status of the Webhook
The name of a team member who is contacted in case the connection fails
The payload URL
If necessary, select Create New Client Secret, then select Create.
Share the client secret with the administrator of the Webhook.
After the administrator has confirmed they received the client secret, select Done.
Select all the resources and events you want to be notified about.
Note: Resources used in the same Webhook environment aren’t available to more than one Webhook.
Select Save.
View or change the status of a Webhook
If you’re not already signed in to Apple Business Connect, sign in with a user who has the role of Administrator.
If you’re the Administrator for more than one company, select the appropriate company from the Company list
.Select your company in the sidebar, then select API below the company name.
Select
next to Manage Webhooks, then view the Webhook list.Change the status of the Webhook to turn it On or Off.
Turning off a Webhook stops notifications from being delivered to it.
Remove a Webhook
If you’re not already signed in to Apple Business Connect, sign in with a user who has the role of Administrator.
If you’re the Administrator for more than one company, select the appropriate company from the Company list
.Select your company in the sidebar, then select API below the company name.
Select
next to Manage Webhooks, then view the Webhook list.Select a Webhook, then scroll down and select Remove Webhook.
Select Remove, then select Save.