How To: Configure Webhooks

Introduction

Webhooks are easier to configure than APIs, because they do not require traditional API request calls. Set up and use webhooks with the following configurations:

Choose any combination of one to 4 event notifications:

• Order Invoiced
• Order Shipped
• Order Voided
• Order Hold

You have these options when setting up one or more webhooks:

• You can configure one webhook to contain all 4 types of event notification.
• You can configure 4 webhooks, each with one type of event notification.
• Additional combinations are available, such as having 2 webhooks, each with 2 event notification types.

Note: Each type of event notification can appear only once in your set of webhooks. Also, you are not required to use all 4 event notifications.

Configure Webhooks

Once you have your Developer account with Ingram Micro, use these steps to set up one or more webhooks:

1. Log in to the Ingram Micro Partner Portal.
   • https://developer.ingrammicro.com/
2. Click APPS to view the My Apps screen. This screen shows your sandbox and existing subscribed apps.
3. For your Sandbox App or any app you have already created, click Webhooks. The Webhooks screen shows existing webhooks for this app.
4. Click an existing webhook to edit the configuration or click Add Webhook to access the New Webhook screen. The screen for Webhook configuration shows all settings:
5. Provide settings for this webhook:
   • Secret Key: This component validates the notification is from Ingram Micro. You may choose to validate the call using the signature in the HTTP header generated using this secret key.
   • Generate New Key: Use this button to assign a new secret key to this webhook.
   • Destination URL (HTTPS only): Provide a destination URL using a valid HTTPS path. This URL will receive all webhook notifications as POST requests and must be a publicly accessible URL on your website.
     • As an example:
     • Destination: https://www.yourdomain.com
     • Webhook destination URL: https://www.yourdomain.com/webhooks/accept
     • You can create multiple webhook destination URLs to route certain webhook notification events to specific endpoints.

    

   Send Test Event:

   You can initiate a test notification event from the portal to test various events.

   Test that the webhook endpoint is working properly before taking it live. You can create test events from the portal to test the webhook endpoints.

   The following URLs do not work as endpoints for webhooks:

   • Localhost
   • LocalAny URL ending in the word "internal":host
     • For example, thisshop.com/internal
   • Pseudo-domains:
     • For example, www.example.com

    

   Enable or Disable Webhooks

   • You can enable or disable a webhook, which gives you the option of deactivating a webhook without having to delete it.
   • You can also disable a webhook to keep it inactive during setup.

    

   Notification Event Options:

   • Order Invoiced
   • Order Shipped
   • Order Voided
   • Order Hold
6. Click Add Webhook to finish webhook creation.

You can access and edit the configurations for all existing webhooks from the sandbox app.