Advanced Integrated Visibility Webhook Setup
Overview
The Advanced Integrated Visibility webhook enables FedEx to push near real-time, secure tracking event data to a specified destination URL for shipments associated with one or more FedEx account numbers. You can create a webhook project to access this functionality through the FedEx Developer Portal.
Navigation Paths
You can access the webhook creation page through either of the following:
- Via My Projects: Left Navigation Panel → Webhooks tab → +CREATE A Webhook PROJECT
Via API Catalog:
- Left Navigation Panel → API Catalog
- Search for or filter by Advanced Integrated Visibility
- Overview → Click Documentation → In Sandbox Console, click +CREATE A PROJECT
- Docs → Click +CREATE A Webhook
Webhook Creation Steps
Step 1: Select Company Type
Click +CREATE A PROJECT and choose your company type from the dropdown:
- Ships with FedEx and needs to integrate FedEx webhook into their system.
- Sells or provides a software solution that uses FedEx data and is not a certified FedEx Compatible provider.
- Is a certified FedEx Compatible provider.
Note: Currently, the FedEx Advanced Integrated Visibility webhook solution is not available for this option. As a member of the FedEx Compatible program, if you want to access Basic Integrated Visibility or other FedEx integration solutions, please reach out to your channel manager. If you do not know who your channel manager is, contact your company administrator.
Then, select Advanced Integrated Visibility Account Number Subscription as your subscription type.
Creating an Advanced Integrated Visibility Account Number Subscription
This process involves four main steps:
- Configure Project
- Enter Project Details
- Choose Shipping Accounts
- Confirm Details and Accept Terms
Step 1: Configure Project
On the Configure Webhook page:
- Billing Account Number:
- Review the default billing account.
- To change it:
- Click ADD BILLING ACCOUNT TO YOUR ORGANIZATION (if only one account exists), or
- Click SELECT ANOTHER BILLING ACCOUNT (if multiple accounts exist).
Note: A U.S.-based billing account is required. For pricing details, refer to the Advanced Integrated Visibility Overview Pricing Guide.
Feature Selection:
- Choose the features you want to enable, then click Next.
Feature Descriptions
| Field Name | Description |
|---|---|
| Proof of Delivery | Confirms that a shipment has been successfully delivered. Picture Proof of Delivery (PPODA): Provides a photo showing the exact delivery location. Signature Proof of Delivery (SPOD): Provides an image of the recipient’s signature, name, delivery date, time, and location. |
| Estimated Delivery | Helps recipients plan by providing: Estimated Delivery Date (EDD) Estimated Delivery Time Window (EDTW) |
| Tracking Events | Allows selection of one or more event categories to receive notifications: Ship In-Transit Delivery Exceptions Custom Delivery Options |
| Event-Based Filtering | Filters webhook responses to include: Inbound shipments Outbound shipments Third-party shipments |
On the Enter Details page, provide the following information:
| Field Name | Description |
|---|---|
| Webhook Project Name | A unique, non-empty name for your webhook project. A suggested name is auto-filled but can be edited. This name must not be repeated in any other webhook. |
| Destination URL | The secure HTTPS endpoint where FedEx will send tracking event data. Requirements: Must be valid and working Must follow standardized syntax Must not include fedex.com or its subdomains Can be reused across multiple webhooks Refer to the Business Rules and Best Practices section for more details. |
| Security Token | A shared secret used to authenticate and validate webhook responses via HMAC. Requirements: 26–100 characters Must include at least 1 uppercase, 1 lowercase, and 1 numeric character Can be reused across multiple webhooks |
| Payload Language (Country) | Select the preferred language for tracking data translation from the dropdown list. |
| Tracking Type | Choose how tracking data should be delivered: Detailed Tracking – Full event history Event-Specific Tracking – Only the most recent event |
| Email Address | Provide a valid email address to receive notifications. |
| Email Language (Country) | Select the preferred language for email notifications. Note: Only U.S. locales are supported (e.g., en-US, es-US). |
Step 3: Choose Shipping Accounts
On the Choose Shipping Accounts page:
- Select one or more FedEx account numbers to associate with your webhook project.
Important Notes:
- Only accounts not already associated with other webhooks will be shown.
- You must associate at least one account to proceed.
- A maximum of 100 accounts can be added via the webhook UI.
- To associate more than 100 accounts, use the webhooks API.
Contact FedEx Customer Support or Help Desk to request API access.
Step 4: Confirm Details and Create
On the Confirm Details page:
1. Review all the information you’ve entered for the webhook project.
2. Check the box to accept the terms and conditions.
3. Click Create to finalize the webhook setup.
Upon successful submission, the webhook will be created with a system-generated Subscription ID and will be set to Active status.
Validation Rules
General Requirements:
- Webhook Name must be unique.
- Destination URL must follow a standardized syntactical format (secure HTTPS, no fedex.com or its subdomains).
- All required fields must be completed—no mandatory field should be left empty.
- At least one valid FedEx shipping account number must be associated with the webhook.
Successful Validation:
If the webhook is created successfully, the customer will receive a confirmation message:
<<Webhook name>> successfully created. Changes may take up to 10 minutes to go into effect.
Unsuccessful/Failed Validation:
If FedEx receives any response other than HTTP 200 (OK) or 202 (Accepted) from the destination URL, the webhook validation will be considered failed.
