Introduction to Advanced Integrated Visibility
Advanced Integrated Visibility webhook is a software architecture method to automate push notifications that occur between sender and receiver applications whenever a new event happens.
Advanced Integrated Visibility webhook is described as a user-defined HTTPS callbacks (typically POST request) triggered by change in status of a specific event. It sends near real-time automated notifications (messages/information/data) from sender (server-side) application to receiver (client-side) application based on the "Event Reaction" concept (i.e., don’t contact me, I will only contact you if I have something new for you).
API vs Advanced Integrated Visibility Workflow
Below pictorial representation describes how the event data is received in case of API request and with the Advanced Integrated Visibility webhook .

FedEx Advanced Integrated
Visibility Overview
FedEx customers can subscribe to Account number or Tracking number to receive near real time in-transit shipment events, from label creation to Proof of delivery of packages, including Picture Proof of Delivery.
Subscription Types
FedEx customers can subscribe to Advanced Integrated Visibility by the following options:
- By Account Number- Subscribe to FedEx Account Number to receive updates for shipments matched to the account.
- By Tracking Number- Subscribe to FedEx Tracking Number to receive updates for shipments matched to the specified tracking numbers through API endpoints.
Note: Subscriptions currently require U.S. based FedEx 9-digit account for billing, and customers are charged a monthly fee based on the count of Tracking Numbers. To know more about the pricing of the Advanced Integrated Visibility refer to the Advanced Integrated Visibility Overview Pricing Guide.
If subscribed by Account number, Subscriptions currently require FedEx 9 digit US based shipping accounts.
Below table gives you the information about the features of account number subscription and Advanced integrated visibility tracking number subscription
Features | Account Number Subscription | Tracking Number Subscription |
---|---|---|
Response | Secured data = Personally identifiable information (PII) data Shipper and Recipient data SPOD CDOs (Convenient Delivery Option)/response | Anonymous data(Includes Shipment, In-Transit updates excluding PII - Personally identifiable information/response |
Association | Association by an account number = Associating all linked tracking numbers at once | Association of tracking numbers |
Ownership | Account numbers need to be owned by user themselves | Tracking numbers need not be owned by the user |
Filtering | Has the ability to filter events by inbound, outbound and third-party shipments |
Cannot filter events |
Integration | Association of account numbers is through UI | Association of tracking numbers is through API endpoint |
Limitation | Can add upto 100 account numbers | Can add upto 1000 tracking number per request |
Suitable Use Case | 1st party customers- If customer owns the account numbers | 3rd party customers- If customer has tracking numbers belonging to 1st party customers |
Sandbox Console
Status

Success
Test webhook tracking event details delivered successfully

Error
Test webhook tracking event details delivery failed
FedEx Integrated Visibility – Feature Comparison by Subscription Type
Feature / Data Element | Tracking Number Subscription | Account Number Subscription | Notes |
---|---|---|---|
SPOD (Signature Proof of Delivery) | Not Available | Available (config required) | Signature image in TIFF format, delivered in payload |
PPOD (Picture Proof of Delivery) | Available (config required) | Available (config required) | JPEG image of delivery location, base64 encoded |
PPODA (Picture Proof of Delivery Attempt) | Available (config required) | Available (config required) | For delivery attempts, JPEG image provided |
GPS Coordinates (gpsPodCoordinates) | Not Available | Available | Masked in tracking-based subscriptions |
Contact Info (Name, Phone, Company) | Masked | Available | Across shipper, recipient, origin, destination, broker, etc. |
Street Address & Postal Code | Masked | Available | streetLines and postalCode are masked in tracking-based payloads |
Account Numbers | Masked | Available | Includes billTo, shipper, and recipient account values |
Package Financials (e.g., declaredValue, codAmount) | Masked | Available | Customs, COD, and declared values are masked |
Inquiry & Return Details (Inquiry codes, Return reasons) | Masked | Available | Full details only shown for account-based subscribers |
Commodity & Contents Data | Masked | Available | Includes part codes, descriptions, quantitie |
Employee ID (e.g., event personnel) | Masked | Not Available | Masked in both cases for privacy reasons |
Event Notifications & EDD/EDTW | Available | Available | Estimated delivery date/time features supported on both |
Multi-Parcel Shipment (MPS) | Available | Available | With additional tracking info |
Estimated Delivery Confidence & Risk Scores | Available | Available | Part of Premium Tier only |
Customer Benefits:
- Improve recipient confidence with proactive notifications for in-transit changes to Estimated Delivery Date and day of delivery Time Window.
- Reduce customer service costs for WISMO (Where Is My Order) calls as well as delivery disputes by providing FedEx Picture Proof of Delivery.
- Enhance customer experience by providing near real time notifications on shipment status.
- Gain operational efficiencies by receiving real time push update on shipments, instead of polling continuously to check for track updates on every shipment.
Features and Tracking Events
Tracking Events
This feature allows to track the status of shipments proactively notify customers on different updates in the shipment lifecycle. It provides the customers with options to choose the exact stage of the shipment process/events they wish to receive a notification/alert for. The available shipping events are:
- Ship: This option provides notification when the selected shipment event occurs. Example: Label Created, Pickup, etc.
- In transit: This option provides notification for the shipment transit events. Example: In transit, item held at delivery office, etc.
- Delivery: This option provides notification for the shipment delivery events. Example: out for delivery, delivered, etc.
- Exceptions: This option provides notification for the delivery exceptions. Example: clearance delay, etc.
- Convenient delivery options: Select this option to receive notification for some personalized tracking events. Example: hold at location request accepted.
For more information on the available shipment event options, refer to the Status Codes and Statuses for Advanced Integrated Visibility Tracking Events table.
Proof of Delivery
This feature is used to acknowledge an order has successfully arrived at its intended destination. This includes:
- Picture proof of delivery (PPOD): PPOD allows customers to receive a picture of the exact location of their package once it is delivered to their doorstep.
Advanced Integrated Visibility delivers the PPOD images in the JSON payload in a base64 format. The images can then be converted to a JPEG format.
Note:
- PPOD is available in the U.S., Canada, Puerto Rico, Hong Kong, New Zealand, United Kingdom, and Ireland.
- PPOD is only available for FedEx Ground, FedEx Express and residential packages/address(es).
- PPOD is available for eligible deliveries when SPOD is not required. PPOD and SPOD are not available together.
- PPOD is available for on-signature required (NSR) deliveries that are not given directly to a customer (e.g. handed directly to a customer during delivery).
- PPOD supports image size from 14000 to 33000 bytes (Applicable for 320 x 240 resolution image).
- Picture proof of delivery attempt (PPODA): PPODA allows customers to receive a picture of the exact location of where the package is to be delivered, in the event that delivery cannot be completed. Advanced Integrated Visibility delivers the PPODA images in the JSON payload in a base64 format. The images can then be converted to a JPEG format.
- PPODA is available in the U.S. and Puerto Rico.
- PPODA is only available for FedEx Ground, FedEx Express and residential and commercial packages/address(es).
- PPODA Image can be:
- PPODA image photo of Doortag on Door.
- Photo of Obstruction to Delivery Point (i.e., locked gate).
- PPOD Image of Packages Delivered at the stop.
- PPODA supports image size from 14000 to 33000 bytes (Applicable for 320 x 240 resolution)
- Signature proof of delivery (SPOD): SPOD allows customers to receive an image of the recipient’s signature as well as their name delivery date, time and location. The SPOD information will be presented as a byte array instead of an image. The byte array is a base64 encoded string, which should be decoded to get the final signature image in PNG format
- SPOD is not available for Advanced Integrated Visibility Tracking Number Subscription.
- The SPOD image size will be from 4000 to 6000 bytes (Applicable for 400x95 resolution image).
- The SPOD image size will be from 5000 to 8000 bytes (Applicable for 230x150 resolution image).
- GPS proof of delivery (GPSPOD):
- GPS POD allows customers to receive the geographical coordinates of the delivery location.
Note: GPSPOD is available by default for advanced integrated visibility account number subscription.
- GPS POD allows customers to receive the geographical coordinates of the delivery location.
Estimated Delivery Date and Delivery Time Window Events
This feature helps recipients of the shipments plan their schedules by providing a date and/or time range for shipment deliveries. This includes:
- Estimated delivery date (EDD): This option provides an estimated date of delivery of the shipment to the recipient. Example: Nov, 20, 20XX.
- Estimated delivery time window (EDTW): This option provides the recipient with an estimated time window for the shipment delivery on the day of actual delivery. Example: 2pm to 6pm.
Event Based Filtering
This feature allows customers to organize their webhook projects based on the billing methods for the shipments. The options are:
- Inbound: select this option for shipments that will be delivered to you and will be paid for, by you as the recipient.
- Outbound: select this option for shipments that will be shipped by you and will be paid for, by you as the sender.
- Third-party: select this option for inbound and outbound shipments that are billed to you as a third-party payer.
Note: Your FedEx account number will be used to bill or pay for the shipments. For third-party payer, you may not be the shipper or recipient, but the charges will be billed to your FedEx account number.
Retry Policy
This feature prevents FedEx from sending tracking event data in the event of a client-side issue. FedEx will hold the data and attempt to resend it within a span of 3 retries within 5 minutes intervals.
If FedEx does not receive a successful response in the defined time span, then FedEx will stop redelivery of that specific event. However, customer can request for missed events over a period of last 7 days through a manual "RETRY" button on the Advanced Integrated Visibility webhook project Details page.
For more information on retry policies, refer to the Retry mechanism section.
Business Rules and Best Practices
- One shipping account number cannot be used in multiple Advanced Integrated Visibility.
- The destination URL/endpoint created by the customer must:
- Be of HTTPs host.
- Respond to POST requests and parse JSON payloads.
- Character limit to 200 characters
- Your URL will be blocked if it includes:
- RFC1918 IP space
- fedex.com or any of its subdomains
- IP addresses in the URL (including localhost, 127.0.0.1)
- Be of HTTPs host.
- Advanced Integrated Visibility Security: Only HTTPS connections using TLS (SSL) 1.2 or higher protocol versions that is configured with a certificate from a valid certificate authority (CA) is supported. Whitelist the below IP addresses to receive updates from FedEx servers without any interruptions:
Prod Clients can whitelist: “nat.fxconnect.eastus2.heap-prod.fedex.io”
Using CIDR "20.65.16.22/31"
- Customers may sometimes receive the tracking event updates out of order and must look at the scan event time stamp for the correct order.
- Deleting Account(s) in FedEx Developer Portal:
- User/Customer cannot delete the account(s):
- If it is associated with any active Advanced Integrated Visibility.
- If the account is available or associated with a project, and
- If it is the only account in a project/Advanced Integrated Visibility.
Note: User/Customer needs to remove the account from the project/Advanced Integrated Visibility first and then delete it from the organization.
- If it is associated with any active Advanced Integrated Visibility.
- User/customer can delete the account(s):
- The account must belong to the same organization.
- User/Customer must be an admin to delete accounts from the organization.
- User/Customer cannot delete the account(s):
Common Constraints
- All customer shipments associated with the FedEx 9-digit account numbers of operating companies- FedEx Express®, FedEx Ground® and FedEx Ground® Economy (formerly known as FedEx SmartPost®) are in scope irrespective of destination or origin (inbound, outbound, international, domestic, etc.).
- Advanced Integrated Visibility webhook only supports 9-digit enterprise/parcel enabled accounts. Enterprise accounts enable the creation of shipments associated with all FedEx operating companies including FedEx Express and FedEx Ground.
- Customers must manage the order of the shipment tracking events received on their end.
- Automated email notifications are sent whenever there is any activity (Saved/Failed/Create/Update/Cancel/Delete) on the subscribed Advanced Integrated Visibility webhook.
- Translations:
- Tracking payload translations are supported in 41 languages (locales).(Coming Soon)
Click here to view the list of supported languages. - Currently tracking payload translation is supported in English (United States).
- Email notification translations is available for languages supported by U.S. regions only. (Locale: en-US, es-US)
- Tracking payload translations are supported in 41 languages (locales).(Coming Soon)
FedEx Developer Portal User roles:
Within the FedEx Developer Portal, you can perform specific functions based on the configured role.
To learn more about FedEx Developer Portal, refer to the Organization Administration Guide.
Test Webhook
You can use the Test Webhook URL feature to test the type of tracking data returned to the Destination URL (receiver/listener server). This helps to validate the URL and data returned prior to creating a Advanced Integrated Visibility webhook.
Navigation:
Following are the ways to navigate to Test Webhook URL Sandbox Console:
- My Projects (on the left Navigation Panel) -> Advanced Integrated Visibility tab -> Test webhook URL button->in Sandbox Console, click on Try this Advanced Integrated Visibility
- API Catalog (on the left Navigation Panel) -> search for Advanced Integrated Visibility/click on Advanced Integrated Visibility in FILTERS -> Advanced Integrated Visibility card:
- -> Overview -> Documentation button -> in Sandbox Console, click on Try this Advanced Integrated Visibility.
- -> Docs -> in Sandbox Console, click on Try this Advanced Integrated Visibility.
Steps:
Following are the steps to use Test Webhook URL functionality:
- Click on Test Webhook URL button.
- Enter the following Test parameters:
Field Name Description Destination URL
This is the URL to receive the Tracking event data/payload.
- Customer should provide a working and valid destination URL.
- Destination URL provided must be in the standardized syntactical format (secure https URL).
Security Token
Used as shared secret to authenticate and validate Advanced Integrated Visibility webhook response.
- Token value must be between minimum length of 26 characters and maximum of 100 characters.
- At least 1 uppercase, 1 lowercase and 1 numeric character are required.
- Security Token will be used to create Hash-based Message Authentication Code (HMAC) signature for response validation.
Payload language
Select the preferred language for tracking data translation from the drop-down list. Following are the available 6 sample languages:
- English (United States)(Default)
Tracking Type
Select type of response in which tracking data needs to be received.
- Detailed Tracking Response (Response type consists of secured tracking data with entire history of events).(Default)
- Event-Specific Tracking Response (Response type consists of secured tracking data with only the most recent event information).(Coming soon)
Tracking events
Select one higher-level category to receive email notifications related to shipment events in the package lifecycle. Following are the higher-level categories:
- Ship
- In Transit
- Delivery
- Exceptions
- Estimated Delivery
Status Event
A tracking event in the packages’ lifecycle. Select one of the tracking events to be received. Following are the available 10 sample status events:
- Picked up
- In transit
- Delivered
- Delivery Exception
Note: “Status Event” field values will be populated based on the selected "Tracking Event Category”. Refer the following table to learn more about the “Tracking Event Category” and their respective “Status Events”.
Status Event Category Status Event Ship
- Picked up
In-Transit
- In transit
Delivery
- Delivered
Exceptions
- Delivery Exception
Estimated Delivery(Coming Soon)
- Estimated Delivery Date (EDD)
- Estimated Delivery Time Window (EDTW)
- Check the FedEx Developer Portal License Agreement (FDPLA) box to Sign/Accept the License Agreement.
- Click the PUSH button to view test results.
Response :
Following are the response parameters in the Sandbox:
- Body – The body contains the response parameters in the Test Webhook URL tab within Sandbox Console.
- Status – This section in Test Results tab provides you the status of the request that is processed.
Sample Success Message:
Success
Test Advanced Integrated Visibility tracking event details delivered successfully.
If test event delivery fails, the STATUS will be displayed as Error in Test Results tab with respective error code and error message.
Sample Error Message:
Error Code:<<error code>>
Test Advanced Integrated Visibility tracking event details delivery failed.
Validation Rules:
- Advanced Integrated Visibility URL must be in Standardized Syntactical format.
- All the required fields for testing a Advanced Integrated Visibility URL must not be empty.
- For Successful Validation:
- FedEx will send a request with sample event JSON. Note: Advanced Integrated Visibility destination URL should respond with 200 (OK) as HTTP status code to FedEx.
- For Unsuccessful/Failed Validation:
- If FedEx receives any response other than 200 (OK), then the validation of the Advanced Integrated Visibility destination URL will be considered as failed.
- FedEx will display the error code and error message in Test Results tab
Advanced Integrated Visibility Validation Process
What is a MAC/HMAC and how is it used in the validation process?
A message authentication code (MAC) provides a way to check the integrity of information transmitted over or stored in an unreliable medium, based on a secret key. Typically, MACs are used between two parties that share a secret key to validate information transmitted between the two parties.
A MAC mechanism that is based on cryptographic hash functions is referred to as HMAC. HMAC can be used with any cryptographic hash function, e.g., SHA256, in combination with a secret shared key. HMAC is specified in RFC 2104. FedEx Advanced Integrated Visibility webhook will use HMAC SHA256.
SHA256( security token + payload) = Base 64 encoded fdx-signature as part of payload Header
Example (of a pseudocode snippet to illustrate an HMAC SHA256 hashing):
- First, initialize MAC using HmacSHA256 algorithm and the security token as the secret key.
- Then, finalize the MAC operation by hex encoding the request payload sent by FedEx.
- This final hash should match with the value of the header fdx-signature in the PUSH sent by FedEx.
Mac mac = Mac.getInstance("HmacSHA256");
mac.init(new SecretKeySpec(secureToken.getBytes(), "HmacSHA256"));
return new String(Base 64 encoded(mac.doFinal(payLoad.getBytes())));
Note: The secret key used is the secure token that you will provide when setting up the Advanced Integrated Visibilityor when testing the Advanced Integrated Visibility URL.
Validation Rules:
- Advanced Integrated Visibility webhook Name should be unique.
- Advanced Integrated Visibility webhook Destination URL must be in Standardized Syntactical format.
- All the required fields for creating a Advanced Integrated Visibility webhook must not be empty.
- At least one available FedEx shipping account number should be associated for creating a Advanced Integrated Visibility webhook .
- For Successful validation:
- When a Advanced Integrated Visibility webhook is created successfully, customer will receive a confirmation message.
Sample Confirmation Message: <<Advanced Integrated Visibility webhook name>> successfully created. Changes may take up to 10 minutes to go into effect.
- When a Advanced Integrated Visibility webhook is created successfully, customer will receive a confirmation message.
- For Unsuccessful/Failed validation:
- If FedEx receives any response other than 200 (OK) or 202 (Accepted), then the validation of the Advanced Integrated Visibility webhook destination URL will be considered as failed.
Create Advanced Integrated Visibility
The Advanced Integrated Visibility webhook allows FedEx to push near real-time secured tracking event data to a destination URL for shipments associated with a specific FedEx account number(s).
Create Advanced Integrated Visibility
You can create a Advanced Integrated Visibility webhook project on FedEx Developer Portal and then associate the Advanced Integrated Visibility either to one or more FedEx account numbers or FedEx tracking numbers based on your selected subscription type. Navigate to the top of the page and select the desired Advanced Integrated Visibility subscription type tab: Advanced Integrated Visibility Account Number Subscription or Advanced Integrated Visibility Tracking Number Subscription, to view the steps to create the respective Advanced Integrated Visibility webhook.
Managing Advanced Integrated Visibility
The management console is available on the FDP for managing the Advanced Integrated Visibility webhook . The console provides you with the options to edit,retry and cancel the active Advanced Integrated Visibility webhook as required.
Navigation:
Following is the way to navigate to MANAGE Advanced Integrated Visibility ( Advanced Integrated Visibility Management Console) page:
- My Projects (on the left Navigation Panel) -> Advanced Integrated Visibility tab -> MANAGE Advanced Integrated Visibility page
Common Limitations:
- Customer must always provide a secure https destination URL in standardized syntactical format and be validated as a working event receiver.
- FedEx will push Tacking Event data to customer’s destination URL in a standardized JSON format in the selected language (locale).
- Unique Fields that cannot be repeated in multiple Advanced Integrated Visibility webhook: Advanced Integrated Visibility webhook Name, Subscription Id and FedEx shipping account number.
- Any changes (SAVED/CREATED/EDITED/RESUBMIT) made to a Advanced Integrated Visibility webhook could take up to 10 minutes to get into effect.
- ACTIVE webhook(s) will stay active indefinitely unless:
- The Advanced Integrated Visibility is CANCELLED.
- View details option is available only for ACTIVE Advanced Integrated Visibility.
- FAILED Advanced Integrated Visibility(s) will be available in Advanced Integrated Visibility Management Console for 30 days only.
- If no action (EDIT and RESUBMIT/DELETE) is taken within 30 days, the failed Advanced Integrated Visibility(s) will get automatically deleted.
- Any saved for later Advanced Integrated Visibility webhook will be shown as IN-PROGRESS in Advanced Integrated Visibility Management Console for 90 days only.
- If no actions (continue creating or delete) is taken within 90 days, the in-progress Advanced Integrated Visibility(s) will get automatically deleted.
Edit Advanced Integrated Visibility
You can use this option to add, update or remove information/details in field(s) of an existing Advanced Integrated Visibility webhook.
Steps:
Follow below steps for Editing a Advanced Integrated Visibility webhook:
- Select My Projects on the left Navigation Panel.
- Select Advanced Integrated Visibility tab.
- Select Individual Webhook listed under My Advanced Integrated Visibility.
- Select Edit action from the kebab menu (⋮) on the respective Advanced Integrated Visibility.
- On the Configure Advanced Integrated Visibility page:
- Check the default billing account number displayed for your organization. If you want to change the billing account number, click on ADD BILLING ACCOUNT TO YOUR ORGANIZATION (if you have a single billing account) or SELECT ANOTHER BILLING ACCOUNT (this option is displayed if you have multiple billing accounts under your organization).
- Select the features you need and click on Next.
Note: To learn more about the features, click on the help icon (?) next to the feature.
- On the Enter Details page, select the field(s) you would like to edit and select Next.
- For Advanced Integrated Visibility Account Number Subscription, on the Choose shipping accounts page, add or remove the accounts associated with the Advanced Integrated Visibility and select Next.
- On the Confirm details page, check the changes made in the Advanced Integrated Visibility webhook project and select Next to confirm.
The successful request submission will update the Advanced Integrated Visibility, and it will remain in ACTIVE status.
Validation Rules:
- When the changes are updated successfully, you should receive a confirmation message.
Sample Confirmation Message: <<Advanced Integrated Visibility name>> is successfully updated. Changes may take up to 10 minutes to go into effect.
- The unsuccessful/failed Validation:
- Validation to the destination URL is considered as failed if, FedEx receives responses other than 200 (OK) or 202 (Accepted).
- Subscription ID associated with an existing Advanced Integrated Visibility webhook remains un-changed when a customer edits/updates the Advanced Integrated Visibility(s).
- It will take 10 minutes for the updated changes of an existing Advanced Integrated Visibility webhook to go into effect.
- If you click on cancel during the edit Advanced Integrated Visibility webhook workflow, the edit workflow will be aborted, and you will be navigated back to the previous page (Advanced Integrated Visibility Management Console page).
- When an account is associated to a Advanced Integrated Visibility webhook, FedEx will push events happening for new shipments created thereafter for that account.
- When an account is dissociated from a Advanced Integrated Visibility webhook, FedEx will push all the already matched or in-flight shipments data and will not push any data for new shipments created thereafter.
View Advanced Integrated Visibility Details
You can use this option to view details/configurations of an existing Advanced Integrated Visibility webhook.
Steps:
Follow below steps to view a Advanced Integrated Visibility webhook:
- Select My Projects on the left Navigation Panel.
- Select Advanced Integrated Visibility tab.
- Select Individual Advanced Integrated Visibility listed under My Advanced Integrated Visibility.
- Select View Details action from the kebab menu (⋮) on the respective Advanced Integrated Visibility.
Below table represents the view details page for the selected subscription type.
Tab Name | Section Name | Account Number Subscription | Tracking Number Subscription |
---|---|---|---|
Production keys |
Security Details |
|
|
Project details | Billing Details |
|
|
Project Details |
|
|
|
Features Selected |
|
|
|
Project history | History Detail |
|
|
Project Members | Users | This shows all the project members who have access/have been added to the Advanced Integrated Visibility webhook project. | This shows all the project members who have access/have been added to the Advanced Integrated Visibility webhook project. |
Role | This shows the users corresponding project roles. | This shows the users corresponding project roles. | |
Action | This provides an option for the admins to remove users with contributor or viewer roles from the project. | This provides an option for the admins to remove users with contributor or viewer roles from the project. |
Cancel Advanced Integrated Visibility
If an active Advanced Integrated Visibility webhook is no longer needed, use this option to cancel it.
Steps:
Follow below steps for cancelling a Advanced Integrated Visibility webhook:
- Select My Projects on the left Navigation Panel.
- Select Advanced Integrated Visibility tab.
- Select Individual Advanced Integrated Visibility listed under My Advanced Integrated Visibility.
- Select CANCEL action from the kebab menu (⋮) on the respective Advanced Integrated Visibility.
- You can cancel the Advanced Integrated Visibility in the Edit screen using CANCEL button.
Response:
- When a Advanced Integrated Visibility webhook is cancelled successfully, you will receive a confirmation message.
Sample Confirmation Message: <<Advanced Integrated Visibility webhook Name>> is successfully cancelled.
- When a Advanced Integrated Visibility webhook is not cancelled successfully, you will receive an error message.
Sample Error Message: We are unable to process your request at the moment. Please try again later.
Error Code: <<error code>>
Delete Advanced Integrated Visibility
If a saved or failed Advanced Integrated Visibility webhook is no longer needed, use this option to delete it.
Steps:
Follow below steps for Deleting a Advanced Integrated Visibility:
- Select My Projects on the left Navigation Panel.
- Select Advanced Integrated Visibility tab.
- Select Individual Advanced Integrated Visibility webhook listed under My Advanced Integrated Visibility.
- Select Delete action from the kebab menu (⋮) on the respective Advanced Integrated Visibility.
- You can delete the Advanced Integrated Visibility webhook in the Edit screen using DELETE button.
Response:
- When a Advanced Integrated Visibility webhook is deleted successfully, you will receive a confirmation message.
Sample Confirmation Message: <<Advanced Integrated Visibility webhook Name>> is successfully deleted.
- When a Advanced Integrated Visibility webhook is not deleted successfully, you will receive an error message.
Sample Error Message: We are unable to process your request at the moment. Please try again later.
Error Code: <<error code>>
Searching Advanced Integrated Visibility
You can search Advanced Integrated Visibility webhook based on Advanced Integrated Visibility webhook Name, Destination URL, Subscription ID and Account Number.
Sorting Advanced Integrated Visibility
You can sort the Advanced Integrated Visibility webhook in ascending or descending order based on Advanced Integrated Visibility webhook Name, Last Modified (date) and Status columns for better visibility.
Filtering Advanced Integrated Visibility
- You can filter Advanced Integrated Visibility webhook based on the single status (Active/Processing/Failed) or multiple statuses selection of the Advanced Integrated Visibility webhook.
- You can clear the filter selection by clicking on "CLEAR ALL" button.
Processing Advanced Integrated Visibility
- When a Advanced Integrated Visibility webhook create or edit request(s) takes more than 6 seconds then the status will be set to "PROCESSING".
- ·Advanced Integrated Visibility(s) in "PROCESSING" status are in disabled state. In this state you cannot perform any action.
- ·When a Advanced Integrated Visibility webhook status is set to "PROCESSING", the following message is displayed: "Your request for [Advanced Integrated Visibility webhook project name] is still in progress, check back to see when it is complete."
Failed Advanced Integrated Visibility
- When a Advanced Integrated Visibility webhook create request(s) in “PROCESSING” status fails to create then the status will be set to "FAILED".
- When a Advanced Integrated Visibility(s) is in "FAILED" status, you can perform only below two actions:
- Edit and Resubmit
Using this action, you can edit & submit the failed subscription (either you can submit the request as it is or can edit the details and submit the request again). - Delete
Using this action, you can delete the existing failed Advanced Integrated Visibility webhook .
- Edit and Resubmit
Limitations
- FAILED Advanced Integrated Visibility(s) will be available in Advanced Integrated Visibility webhook Management Console for 30 days only.
- If no action (EDIT and RESUBMIT/DELETE) is taken within 30 days, the failed Advanced Integrated Visibility(s) will get automatically deleted.
Monitoring Failures and Retry Mechanism
You will need to monitor the failures on your end internally and notify FedEx Helpdesk if failures persist.
Retry limitations:
- Retry Mechanism (retry to push event data) occurs only when FedEx does not receive 200 or 202 HTTP status code in response from the destination URL. The retry attempts are made over a span of 15 minutes at 5-minute intervals 3 times over 15 minutes (see retry diagram).
- Each time FedEx tries to deliver the event data and receives anything other than 200 or 202, then that transaction will be considered a failure.
- Every event in the case of a failure will be retried 3 times over 15 minutes with 5-minute intervals in between each retry. If all of those retries fail, then the event will be pushed to a missed events queue which you can retrieve from using the retry mechanism on your Advanced Integrated Visibility webhook project. All failed events that have the following HTTPS series values will be stored for 7 days and can be retrieved by initiating the retry process on your Advanced Integrated Visibility webhook project:
- 200 - Null
- 400 - ClientID does not match
- 401- Data Works token is not valid
- 500 – Null
Retry logic:
Every event in the case of a failure will be retried 3 times over 15 minutes with 5-minute intervals in between each retry. If after all of those retries fail, then the event will be pushed to a missed events queue which you can retrieve from using the retry mechanism on your Advanced Integrated Visibility webhook project.


- Retry logic:
- Attempt 1:
Example: Tracking number 823497234824 is 'Delivered', Client sent 400 response. (Anything other than HTTP status 200/202 is considered failure). In this case, we call attempt 1 as failure.- Attempt 2 - 1min +/ jitter - Retry 1
- Attempt 3 - 2min +/ jitter - Retry 2
- Attempt 4 - 4min +/ jitter - Retry 3
If FedEx receives a successful response like an HTTP status 200 & 202 for any of the retry requests, then FedEx will stop the retry mechanism for a given event.
- Attempt 1:
Important Points to Note:
- Retry Mechanism (retry to push event data) occurs only when FedEx does not receive 200 or 202 HTTP status code in response from the destination URL.
- Each time FedEx tries to deliver the event data and receives anything other than 200 or 202, then that transaction will be considered a failure.
- FedEx will continue to push new event(s) data if they happen while retrying for the original event.
- FedEx will also push for subsequent events happening thereafter for that Advanced Integrated Visibility webhook.
Use cases for Signature Proof of Delivery (SPOD) and Picture Proof of Delivery (PPOD)
Tracking Event | SPOD/PPOD | Result | |
---|---|---|---|
Use Case 1 |
Delivery |
Selected |
You will receive two delivery timestamps:
Note :
|
Use Case 1.1 |
Delivery |
Not Selected |
You will receive only the “Delivery” event timestamp when the package is delivered.
|
Use Case 2 |
Ship/In-Transit/Exceptions |
Selected |
You will receive only one delivery timestamp for the SPOD/PPOD event, which will contain the delivery timestamp along with the SPOD/PPOD image byte array. If SPOD/PPOD is not selected, then you will not receive any delivery timestamp information. Note :
|
Use Case 2.1 |
Ship/In-Transit/Exceptions |
Not Selected |
You will not receive any delivery timestamp information. Note: You will not receive Advanced Integrated Visibility notifications for any delivery of packages with and without SPOD/PPOD also. |
Masked Data Fields for Advanced Integrated Visibility Tracking Number Subscription
Summary
When customers subscribe to shipment tracking updates using the Advanced Integrated Visibility Tracking Number Subscription instead of the Advanced Integrated Visibility Account Number Subscription, specific data fields are masked to maintain customer privacy and comply with data security policies.
This masking ensures that sensitive information—such as personal contact details, addresses, and financial values—is only accessible to authorized parties. Customers using the Advanced Integrated Visibility Tracking Number Subscription will see ‘XXXXX’ for the masked fields listed below, even though this data may be available through the Advanced Integrated Visibility Tracking Number Subscription.
The implications of this masking include:
- Limited visibility into origin/destination details and involved parties.
- Absence of personal identifiers (e.g., names, phone numbers) and financial or customs-related data.
- Designed protection of proprietary or sensitive shipment information for security and regulatory compliance.
Customers requiring access to these masked fields for operational or business use cases are advised to subscribe using their Account Number.
Data points that are MASKED in Advanced Integrated Visibility Tracking Number Subscription:
Scan Events
- scanEvent/location/locationContactAndAddress/address/streetLines
- scanEvent/location/locationContactAndAddress/contact/phoneNumber
- scanEvent/location/locationContactAndAddress/contact/companyName
- scanEvent/location/locationContactAndAddress/contact/personName
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/address/streetLines
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/contact/phoneNumber
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/contact/companyName
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/contact/personName
Shipper Information
- trackResult/shipperInfo/contactAndAddress/address/postalCode
- trackResult/shipperInfo/contactAndAddress/address/streetLines
- trackResult/shipperInfo/contactAndAddress/contact/phoneNumber
- trackResult/shipperInfo/contactAndAddress/contact/companyName
- trackResult/shipperInfo/contactAndAddress/contact/personName
- trackResult/shipperInfo/account/value
Recipient Information
- trackResult/recipientInfo/contactAndAddress/address/postalCode
- trackResult/recipientInfo/contactAndAddress/address/streetLines
- trackResult/recipientInfo/account/value
- trackResult/recipientInfo/contactAndAddress/contact/phoneNumber
- trackResult/recipientInfo/contactAndAddress/contact/companyName
- trackResultecipientInfo/contactAndAddress/contact/personName
Origin & Destination Location
- trackResult/originLocation/locationDetail/locationContactAndAddress/contact/personName
- trackResult/originLocation/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/originLocation/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/originLocation/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/originLocation/locationDetail/locationContactAndAddress/address/postalCode
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/contact/personName
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/address/postalCode
Delivery and Address Change Details
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/address/postalCode
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/address/gpsPodCoordinates
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/contact/personName
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/address/postalCode
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/contact/personName
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/contact/companyName
Broker Information
- trackResult/broker/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/broker/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/broker/locationDetail/locationContactAndAddress/contact/personName
- trackResult/broker/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/broker/locationDetail/locationContactAndAddress/address/postalCode
Package and Financial Details
- trackResult/packageDetail/customsValue/value
- trackResult/packageDetail/declaredValue/value
- trackResult/packageDetail/originalTransportationCharge/value
- trackResult/codDetail/codAmount/value
Inquiry & Commodity Information
- trackResult/inquiries/[Array]/categoryCode
- trackResult/inquiries/[Array]/code
- trackResult/inquiries/[Array]/createTime
- trackResult/inquiries/[Array]/statusCode
- trackResult/commodityInfo/[Array]/description
- trackResult/commodityInfo/[Array]/code
Package Contents & Return Reason
- trackResult/contents/[Array]/partNumber
- trackResult/contents/[Array]/partCode
- trackResult/contents/[Array]/description
- trackResult/contents/[Array]/quantity
- trackResult/returnReason/[Array]/code
- trackResult/returnReason/[Array]/description
Billing Information
- trackResult/billToParties/[Array]/billToParty/accountNumber
Additional Information:
- To learn more about the production keys (API and secret key), refer to API Authorization documentation page.
- To learn more about how to get started with FedEx APIs, refer the Getting Started guide .
- To learn more about FedEx project roles, refer the Organization Administration Guide.
- To learn more about pricing refer to Advanced Integrated Visibility Overview .
How Advanced Integrated Visibility Works
The Advanced Integrated Visibility webhook allows FedEx to push near real-time secured tracking event data to a destination URL for shipments associated with a specific FedEx account number(s). You can create a Advanced Integrated Visibility webhook project to access this functionality.
Navigation:
Following are the ways to navigate to Advanced Integrated Visibility webhook page:
- My Projects (on the left Navigation Panel) -> Advanced Integrated Visibilitytab -> +CREATE A Advanced Integrated Visibility PROJECT
- API Catalog (on the left Navigation Panel) -> search for Advanced Integrated Visibility/click on Advanced Integrated Visibility in FILTERS -> Advanced Integrated Visibility card:
- ->Overview -> Documentation button -> in Sandbox Console, click on +CREATE A Advanced Integrated Visibility PROJECT
- -> Docs ->+CREATE A Advanced Integrated Visibility PROJECT
Steps:
Following are the steps for creating Advanced Integrated Visibility:
- Click on +CREATE A Advanced Integrated Visibility webhook PROJECT button.
- On the pop-up window, select one of the below options from the dropdown menu to specify the type of company for which you need Advanced Integrated Visibility webhook access.
- 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.
Note: Currently, the FedEx Advanced Integrated Visibility webhook solution is not available for this option. - 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. - Select your subscription type as Advanced Integrated Visibility Account Number Subscription.
Create an Advanced Integrated Visibility Account Number Subscription
You can create an Advanced Integrated Visibility Account Number Subscription to push near real-time secured tracking event data to the destination URL for shipments associated with one/multiple FedEx account number(s).
Creation of a Advanced Integrated Visibility Account Number Subscription is a four-step process:
- Step 1: Configure Project
- Step 2: Enter Project Details
- Step 3: Choose Shipping Accounts
- Step 4: Confirm Details and Accept Terms
Steps:
Following are the steps for creating an Advanced Integrated Visibility Account Number Subscription:
- On the Configure Webhook page:
- a. Check the default billing account number displayed for your organization. If you want to change the billing account number, click on ADD BILLING ACCOUNT TO YOUR ORGANIZATION (if you have a single billing account) or SELECT ANOTHER BILLING ACCOUNT (this option is displayed if you have multiple billing accounts under your organization).
Note:- A U.S. based billing account number is required to pay for webhook subscriptions.
- To check the pricing related information for the webhook projects, refer to the Advanced Integrated Visibility overview page.
- Select the features you need and click on Next.
Note: To know more about the features, click on the help icon (?) next to the feature.
Field Name Description Proof of delivery
This feature is used to acknowledge an order has successfully arrived at its intended destination. This includes:
- Picture proof of delivery (PPOD): PPOD allows customers to receive a photo showing the exact location of their package once it is delivered to their doorstep.
- Signature proof of delivery (SPOD): SPOD allows customers to receive an image of the recipient’s signature as well as their name delivery date, time and location.
Estimated delivery
This feature helps recipients plan their schedules by providing a date and/or time range for shipment deliveries. This includes:
- Estimated delivery date (EDD)
- Estimated delivery time window (EDTW)
Tracking Events
Select one event category to receive email notifications when tracking events occur. Following are the tracking events:
- Ship
- In-Transit
- Delivery
- Exceptions
- Custom delivery options
Event-based filtering
Includes inbound, outbound, or third-party shipments in your webhook response.
- a. Check the default billing account number displayed for your organization. If you want to change the billing account number, click on ADD BILLING ACCOUNT TO YOUR ORGANIZATION (if you have a single billing account) or SELECT ANOTHER BILLING ACCOUNT (this option is displayed if you have multiple billing accounts under your organization).
- On the Enter Details page, enter the following fields:
Field Name Description Webhook Project Name
This is non-empty, unique Webhook project name and should not be repeated in any other Webhooks.
- The Webhook project name is auto populated with a suggested name which can be edited as required.
Destination URL
This is the URL to receive the Tracking event data/payload.
- Customer should provide a working and valid destination URL.
- Destination URL provided must be in the standardized syntactical format (secure https URL, don’t include fedex.com or its sub domains in the URL).
- Customer can repeat destination URL in multiple Webhooks.
To learn more about destination URL and webhook security, refer to the Business rules and best practices section.
Security Token
Used as shared secret to authenticate and validate Advanced Integrated Visibility webhook response.
- Token value must be between minimum length of 26 characters and maximum of 100 characters.
- At least 1 uppercase, 1 lowercase and 1 numeric character are required.
- Customer can repeat the security token in multiple Webhooks.
- Security Token will be used to create Hash-based Message Authentication Code (HMAC) signature for response validation.
Payload Language (Country)
Select the preferred language for tracking data translation from the drop-down list.
Tracking Type
Select the type of response in which tracking data needs to be received.
- Detailed Tracking: This tracking type consists of secured tracking data with entire history of events.
- Event-Specific Tracking: This tracking type consists of secured tracking data with only the most recent event information.
Email address
Provide one Email address.
Email language (country)
Select preferred Language for receiving email notifications.
Note: Email notification translations is available for languages supported by U.S. regions only. (Locale: en-US, es-US)Version
This field shows the version of the webhook being used. The format of version field is “MAJOR.MINOR.PATCH”.
Example: 2.0.0, where:- MAJOR version increment indicates incompatible API changes.
- MINOR version increment indicates addition of functionality in a backwards-compatible manner.
- PATCH version increment indicates backwards-compatible bug fixes.
- On the Choose Shipping Accounts page, select the accounts you would like to associate with the webhook project.
Note:- Only the accounts that are not associated with any other webhooks will be displayed in the list.
- You need to associate minimum one account to the project to proceed to the next step.
- A maximum of 100 accounts can be associated with a single webhook project using the webhook UI. You can add more accounts using the webhooks API. To get access to webhook API, contact FedEx customer support or help desk.
- On the Confirm details page, check the details of the webhook project, check and accept the terms and conditions, and select Create to create the webhook project.
The successful request submission will create a new Advanced Integrated Visibility webhook with a system generated Subscription ID and will have an Active status.
Validation rules:
- Webhook Name should be unique.
- Webhooks Destination URL must be in Standardized Syntactical format.
- All the required fields for creating a Webhook must not be empty.
- At least one available FedEx shipping account number should be associated for creating a Webhook.
- For Successful validation:
- When a Webhook is created successfully, customer will receive a confirmation message.
Sample Confirmation Message: <<Webhook name>> successfully created. Changes may take up to 10 minutes to go into effect.
- When a Webhook is created successfully, customer will receive a confirmation message.
- For Unsuccessful/Failed validation:
- If FedEx receives any response other than 200 (OK) or 202 (Accepted), then the validation of the Webhook destination URL will be considered as failed.
How to Add Large Number of Shipping Accounts (>50) to a Advanced Integrated Visibility
Step 1: Create an Organization
- Navigate to developer.fedex.com.
- Create an organization on the FedEx Developer Portal (FDP).
Step 2: Create a Project
- Create a project on the FDP – CREATE API PROJECT.
- The FedEx API Core team will add the 'Associate Account API' to your project via the WIRA tool.

Step 3: Integrate Associate Account API
- Access the 'Associate Account API' under the Production Keys tab on the FDP.
- Use this API to add accounts to your FDP organization.
- For more details, visit the Associate Accounts API documentation.

Step 4: Create Advanced Integrated Visibility Account Number Subscription
- On the FDP UI, create an 'Advanced Integrated Visibility Account Number Subscription'.
- Ensure you select at least one shipping account via the UI.

Step 5: Add Account Subscription API
- The FedEx API Core team will add the 'Account Subscription API' to your project via the WIRA tool.
Step 6: Access Advanced Integrated Visibility Account Number Subscription API
- For more details, visit the Advanced Integrated Visibility Account Number Subscription API documentation.
Step 7: Integrate Update Webhook Project Endpoint
- Integrate the 'Update Webhook Project Endpoint' to add additional accounts in batches of 50
How Advanced Integrated Visibility Works
The Advanced Integrated Visibility webhook allows FedEx to push near real-time secured tracking event data to a destination URL for shipments associated with a specific FedEx account number(s). You can create a Advanced Integrated Visibility webhook project to access this functionality.
Navigation:
Following are the ways to navigate Advanced Integrated Visibility page:
- My Projects (on the left Navigation Panel) -> Webhooks tab -> +CREATE A WEBHOOK PROJECT
- API Catalog (on the left Navigation Panel) -> search for Advanced Integrated Visibility/click on WEBHOOK in FILTERS -> Advanced Integrated Visibility card:
- -> Overview -> Documentation button -> +CREATE A WEBHOOK PROJECT
- -> DOCS -> +CREATE A WEBHOOK PROJECT
Steps:
Following are the steps for creating Advanced Integrated Visibility webhook :
- Click on +CREATE A WEBHOOK PROJECT button.
- On the pop-up window, select one of the below options from the dropdown menu to specify the type of company for which you need webhook access.
- Ships with FedEx and needs to integrate FedEx webhooks into their system.
- Sells or provides a software solution that uses FedEx data and is not a certified FedEx Compatible provider.
Note: Currently, the FedEx Advanced Integrated Visibility webhook solution is not available for this option. - 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. - Select your subscription type as Advanced Integrated Visibility Tracking Number Subscription.
Create a Advanced Integrated Visibility Tracking Number Subscription
You can create an advanced integrated visibility tracking number subscription to push near real-time secured tracking event data to the destination URL for shipments associated with one/multiple FedEx tracking number(s).
Creation of an Advanced Integrated Visibility Tracking Number Subscription is a four-step process:
- Step 1: Configure Project
- Step 2: Enter Project Details
- Step 3: Confirm Details and Accept Terms
- Step 4: Adding Tracking Numbers
- On the Configure Webhook page:
- Check the default billing account number displayed for your organization. If you want to change the billing account number, click on ADD BILLING ACCOUNT TO YOUR ORGANIZATION (if you have a single billing account) or SELECT ANOTHER BILLING ACCOUNT (this option is displayed if you have multiple billing accounts under your organization).
- Select the features you need and click on Next.
- Picture proof of delivery (PPOD): PPOD allows customers to receive a photo showing the exact location of their package once it is delivered to their doorstep.
- Estimated delivery date (EDD)
- Estimated delivery time window (EDTW)
- Ship
- In-Transit
- Delivery
- Exceptions
- Custom delivery options
- On the Enter Details page, enter the following fields:
Field Name Description Webhook Project Name
This is non-empty, unique Webhook project name and should not be repeated in any other Webhooks.
- The Webhook project name is auto populated with a suggested name which can be edited as required.
Destination URL
This is the URL to receive the Tracking event data/payload.
- Customer should provide a working and valid destination URL.
- Destination URL provided must be in the standardized syntactical format (secure https URL, don’t include fedex.com or its sub domains in the URL).
- Customer can repeat destination URL in multiple Webhooks.
To learn more about destination URL and webhook security, refer to the business rules and best practices section.
Security Token
Used as shared secret to authenticate and validate Advanced Integrated Visibility webhook response.
- Token value must be between minimum length of 27 characters and maximum of 100 characters.
- At least 1 uppercase, 1 lowercase and 1 numeric character are required.
- Customer can repeat the security token in multiple Webhooks.
- Security Token will be used to create Hash-based Message Authentication Code (HMAC) signature for response validation.
Payload Language (Country)
Select the preferred language for tracking data translation from the drop-down list.
Tracking Type
Select the type of response in which tracking data needs to be received.
- Detailed Tracking: This tracking type consists of secured tracking data with entire history of events.
- Event-Specific Tracking: This tracking type consists of secured tracking data with only the most recent event information.
Email address
Provide one Email address.
Email language (country)
Select preferred Language for receiving email notifications.
Note: Email notification translations is available for languages supported by U.S. regions only. (Locale: en-US, es-US)Version
This field shows the version of the webhook being used. The format of version field is “MAJOR.MINOR.PATCH”.
Example: 2.0.0, where:- MAJOR version increment indicates incompatible API changes.
- MINOR version increment indicates addition of functionality in a backwards-compatible manner.
- PATCH version increment indicates backwards-compatible bug fixes.
- On the Confirm details page, check the details of the webhook project, check and accept the terms and conditions, and select Create to create the webhook project.
- After the successful request submission, FedEx will create a new Webhook project is created and you will give get access to production keys for “Advanced Integrated Visibility Tracking Number Subscription API”. You can use this API to associate Tracking Numbers to your project. To learn more, refer the Advanced Integrated Visibility Tracking Number Subscription API documentation page.
Note: To check the pricing related information for the webhook projects, refer to the Advanced Integrated Visibility overview page.
Note: To know more about the features, click on the help icon (?) next to the feature.
Field Name Description Proof of delivery
This feature is used to acknowledge an order has successfully arrived at its intended destination. This includes:
Estimated delivery
This feature helps recipients plan their schedules by providing a date and/or time range for shipment deliveries. This includes:
Tracking Events
Select one event category to receive email notifications when tracking events occur. Following are the tracking events:
How to add tracking number to a webhook
To add a tracking number to your webhook subscription using the Advanced Integrated Visibility Tracking Number Subscription API, do the steps that follow:
- Create an advanced integrated visibility tracking number subscription project using the steps given in the previous section, or using the steps provided in the Getting Started Guide.
- You need an OAuth token to initiate Advanced Integrated Visibility Tracking Number Subscription API calls. To generate OAUTH Token, use the Authorization API. Refer the Authorization API documentation in API catalog for the detailed steps to generate an OAUTH token.
- Click on Project Details option in the left navigation menu. Under the Production Keys tab, scroll down to find the Advanced Integrated Visibility Tracking Number Subscription API documentation.

Once you go to Advanced Integrated Visibility Tracking Number Subscription API documentation you will find three end points:
Track Number Association End point
- Use this End point to add or remove tracking numbers to a given Webhook subscription. Please find more details in the advanced integrated visibility tracking number subscription API documentation.
- Any addition or removal of tracking numbers is an asynchronous job. A job ID is sent as response to add or remove tracking number association API call.
Track Number Job Details End point
This end point provides details about a given Job ID, such as out of all submitted tracking numbers how many are successfully added to given Webhook subscription or how many are still being processed.
Track Number Job Status End point
This End point will enable you to get current summary of all jobs that are being processed.
- Use the generated AUTH token in Step 2 with the Track Number Association end point to add tracking numbers to your Webhook Subscription.
Validation rules:
- Webhook Name should be unique.
- Webhooks Destination URL must be in Standardized Syntactical format.
- All the required fields for creating a Webhook must not be empty.
- At least one available FedEx shipping account number should be associated for creating a Webhook.
- For Successful validation:
- When a Webhook is created successfully, customer will receive a confirmation message.
Sample Confirmation Message: <<Webhook name>> successfully created. Changes may take up to 10 minutes to go into effect.
- When a Webhook is created successfully, customer will receive a confirmation message.
- For Unsuccessful/Failed validation:
- If FedEx receives any response other than 200 (OK) or 202 (Accepted), then the validation of the Webhook destination URL will be considered as failed.
Response