How Advanced Integrated Visibility Works
The Advanced Integrated Visibility webhook lets FedEx send secure, near real-time tracking updates to a specific URL. These updates are for shipments linked to one or more FedEx account numbers. To use this feature, you need to create an Advanced Integrated Visibility webhook project.
How to Access the Advanced Integrated Visibility Page
You can reach the Advanced Integrated Visibility setup in two ways:
Option 1: Through My Projects
1. Go to My Projects in the left navigation panel.
2. Click the Webhooks tab.
3. Select +CREATE A WEBHOOK PROJECT.
Option 2: Through the API Catalog
1. Open the API Catalog from the left navigation panel.
2. Search for Advanced Integrated Visibility.
3. Use the WEBHOOK filter to find the correct card.
4. On the card:
- Click Overview, then the Documentation button, and choose +CREATE A WEBHOOK PROJECT.
- Or go to DOCS and click +CREATE A WEBHOOK PROJECT.
Step 1: Select Company Type
Click +CREATE A PROJECT and choose your company type from the dropdown:
1. Ships with FedEx and needs 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.
Then, select Advanced Integrated Visibility Tracking Number Subscription as your subscription type.
Create an Advanced Integrated Visibility Tracking Number Subscription
You can set up an Advanced Integrated Visibility Tracking Number Subscription to receive secure, near real-time tracking updates for one or more FedEx tracking numbers. These updates are sent to a destination URL you specify.
Steps to Create the Subscription
The process involves four main steps:
1. Configure Project
2. Enter Project Details
3. Confirm Details and Accept Terms
4. Add Tracking Numbers
Step-by-Step Instructions
1. On the Configure Webhook Page:
Check the Billing Account Number
Your organization’s default billing account number will be shown.
To change it:
- Click ADD BILLING ACCOUNT TO YOUR ORGANIZATION (if you have only one account), or
- Click SELECT ANOTHER BILLING ACCOUNT (if you have multiple accounts).
Note: For pricing details, visit the Advanced Integrated Visibility Overview page.
2. Select Features
- Choose the features you need.
- Click Next to continue.
Tip: To learn more about each feature, click the help icon (?) next to it.
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:
|
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). |
3. On the Confirm Details page:
- Review the details of your webhook project.
- Check and accept the Terms and Conditions.
- Click Create to finalize the webhook project setup.
4. Once your request is successfully submitted:
- FedEx will create a new Webhook Project.
- You will receive production keys for the Advanced Integrated Visibility Tracking Number Subscription API.
- You can use this API to associate tracking numbers with your project.
To learn more, refer to the Advanced Integrated Visibility Tracking Number Subscription API documentation page.
How to Add a Tracking Number to a Webhook
To add a tracking number to your webhook subscription using the Advanced Integrated Visibility Tracking Number Subscription API, follow these steps:
Step-by-Step Process
1. Create a Subscription Project
· Use the steps from the previous section or refer to the Getting Started Guide.
2. Generate an OAuth Token
- You need an OAuth token to make API calls.
- Use the Authorization API to generate the token.
- Refer to the Authorization API documentation in the API Catalog for detailed steps.
3. Access API Documentation
- In the left navigation menu, click Project Details.
- Under the Production Keys tab, scroll to find the Advanced Integrated Visibility Tracking Number Subscription API documentation.
API Endpoints Overview
| Endpoint | Purpose |
|---|---|
| Track Number Association | Add or remove tracking numbers from a webhook subscription. This is an asynchronous job. A Job ID is returned in the response. |
| Track Number Job Details | Provides details for a specific Job ID, such as how many tracking numbers were successfully added or are still processing. |
| Track Number Job Status | Returns a summary of all jobs currently being processed. |
Use the OAuth token from Step 2 with the Track Number Association endpoint to add tracking numbers to your webhook.
Validation Rules
- Webhook name must be unique.
- Destination URL must follow standard syntactical format.
- All required fields must be filled.
- At least one valid FedEx shipping account number must be associated.
Validation Outcomes
| Status | Details |
|---|---|
| Successful | A confirmation message is shown: “<> successfully created. Changes may take up to 10 minutes to go into effect.” |
| Unsuccessful | If FedEx receives a response other than 200 (OK) or 202 (Accepted), the webhook destination URL validation is considered failed. |
