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:
1. Via My Projects:
- Left Navigation Panel → Webhooks tab → +CREATE A Webhook PROJECT
2. Via API Catalog:
Left Navigation Panel → API Catalog
Search for or filter by Advanced Integrated Visibility
Choose:
- 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:
1. Ships with FedEx and need to integrate FedEx webhook into their system.
2. Sells or provides a software solution that uses FedEx data and is not a certified FedEx Compatible provider.
3. 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
The creation process involves four key steps:
Step 1: Enabling Advanced Integrated Visibility Account Number Subscription
This step is managed by a FedEx Admin or FedEx Representative upon request from third-party customers.
- MNDA Document: The FedEx Admin or FedEx Representative will collect the Mutual Non-Disclosure Agreement (MNDA) along with a bulk list of 1st Party/Shipper account numbers.
Note: Duplicate account numbers associated to other Organizations are allowed during this upload.
- If applicable, Custom Pricing will be enabled at the organizational level.
Note: This functionality is not included in the July Experience.
Step 2: + Create Project
On the Select Product(s) page:
1. Click on Advanced Integrated Visibility – Account Number and then click Next.
2. Select the billing accounts, accept the payment terms, and click Next.
At least one billing account must be added.
3. On the Confirm Details page:
- Review project information.
- Accept the Terms and Conditions.
- If Custom Pricing applies, the related document will appear automatically.
4. Upon successful creation, a confirmation message will appear:
"You successfully added the product to 'My Project'."
5. Project Overview – API Key Activation Process
- On the Project Overview page, under the API Keys tab in the APIs section, the production status for the subscription will initially appear as "Disabled."
- A FedEx Admin or representative will enable the product upon request.
- Once enabled, the Production Key tab will become accessible, and the production status will be updated to "Awaiting Confirmation."
- After final activation by the FedEx Admin or representative, the production status will be reflected as "Enabled."
Step 3: Project Overview – Configure Webhook
1. Navigate to the Project Overview page.
2. Select the Webhooks tab.
3. Click the + Configure Webhooks button to begin webhook configuration which will be redirected to Webhooks Tab
Feature Descriptions
| Field Name | Description |
|---|---|
| Proof of Delivery | Confirms that a shipment has been successfully delivered. Includes:
|
| Estimated Delivery | Helps recipients plan by providing:
|
| Tracking Events | Allows selection of one or more event categories to receive notifications:
|
| Event-Based Filtering | Filters webhook responses to include:
|
2. 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:
|
| Security Token | A shared secret used to authenticate and validate webhook responses via HMAC. Requirements:
|
| Payload Language (Country) | Select the preferred language for tracking data translation from the dropdown list. |
| Tracking Type | Choose how tracking data should be delivered:
|
| 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.
