Notifications and Webhooks

Notification and Feedback

As a partner, you are responsible for fetching notifications about the resources you have submitted. You should poll the notification service every 15 minutes to check the state of your resources.

Check notifications for:

• Resource State Changes: A location resource, for example, will go from a SUBMITTED to a PROCESSING to a PUBLISHED state during its lifecycle if there are no issues reported.
• Validation Issues: If there are issues with your data, the resource state could be either FAILED or REJECTED, and a feedbackURL will be provided. Use the Get Feedback service to get the details of the specific issue, fix it, and then resubmit the resource.
• Delegation: You can also use the Get Notification service to get delegation details, including the delegating client organization's orgId and brandId.

See Business API > Events > Get Notifications and Get Feedback for more information.

Webhook Messages

You can also use webhooks to receive messages about resources and events through HTTP callbacks. Webhook messages are delivered to your authorized apps or, in the event of a communications error, through the admin email address you have provided.

You can use both webhooks and the Notifications API to monitor your resources and events.

See Business API > Events > Configuring Webhooks for more information.

Webhooks vs. Notifications API

Both webhooks and the Notifications API return the same notifications from event triggers.

note

You can create multiple webhooks, but a resource type can only be assigned to one webhook.

Setting up Webhooks

1. Request API access.

• API Integration Environment (AIE): You can test creating webhooks.
• Data Qualification Environment (DQE): You can test creating webhooks.
• Production: You can create and assign webhooks to resource types and events.

2. From the Apple Business portal, create one or more webhooks. See the Apple Business User Guide > Set up webhooks in Apple Business.

Failed Webhook Notification Delivery

Apple will attempt to deliver webhook notifications five times.

1. If a webhook notification cannot be delivered after ten attempts, Apple Business will:

• Change the webhook connection state in the Apple Business portal to Fail.
• Send an email to notify your webhook admin about the connection failure.

2. After receiving the email notification of a webhook connection failure:

• Sign in to the Apple Business portal and view the webhook state in the list view.
• Select the webhook with the Fail state and view the error code.
• Correct the connection issue.
• If there are no additional errors, the webhook connection will be re-established at the next automatic health check, which runs every 5 minutes.

3. After the connection is re-established, notifications will resume on the webhook.

• Undelivered notifications are held for up to 48 hours and will be resent after the connection is re-established.
• If the connection failure is longer than 48 hours, use the Apple Business Notifications API to pull any missed notifications.