Set up Webhooks in Apple Business
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 available using Webhooks match those available from the Notifications API.
Note: Before you can use a Webhook, you need to have API access to Apple Business and each environment needs to be approved by Apple. See Request API access.
Create your first Webhook
In Apple Business, sign in with a user whose role is an Organization Administrator or Marketing Administrator.
To view roles and permissions, see Intro to roles and permissions.
Select API.
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 user with the role of Organization Administrator or Marketing Administrator 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: When you select Save, a ping is sent to the URL to verify the connection.
Select Save.
Select Copy to copy the client secret to your Clipboard.
Share the client secret with the administrator of the Webhook.
After the administrator confirms they received the client secret, then select Done.
Edit a Webhook
In Apple Business, sign in with a user whose role is an Organization Administrator or Marketing Administrator.
To view roles and permissions, see Intro to roles and permissions.
Select API.
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 user who is contacted in case the connection fails
The payload URL
If necessary, select Create New Client Secret, then select Create.
Note: The client secret is a one-time credential that can’t be retrieved after the session ends, which is why manual sharing and confirmation is required.
Share the client secret with the administrator of the Webhook.
After the Organization Administrator confirms they received the client secret, then 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
In Apple Business, sign in with a user whose role is an Organization Administrator or Marketing Administrator.
To view roles and permissions, see Intro to roles and permissions.
Select API.
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
In Apple Business, sign in with a user whose role is an Organization Administrator or Marketing Administrator.
To view roles and permissions, see Intro to roles and permissions.
Select API.
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.