Fedex Logo

CREATE A
WEBHOOK MANAGE WEBHOOKS

How Advanced Integrated Visibility Works

Advanced Integrated Visibility Webhook Overview

The Advanced Integrated Visibility webhook enables FedEx to securely push near real-time tracking event data to a specified destination URL for shipments linked to designated FedEx account number(s).

To use this functionality, a FedEx Admin or DI Admin must create an Advanced Integrated Visibility webhook project.

 

Navigation Options

You can access the Advanced Integrated Visibility Webhooks page in two ways:

Option 1: Via My Projects

  •  Navigate to My Projects from the left-hand navigation panel.
  •  Click on the Webhooks tab.

Option 2: Via API Catalog

  •  Go to the API Catalog from the left-hand navigation panel.
  •  Use the search bar to find Advanced Integrated Visibility or select it from the FILTERS section.
  •  On the Webhook card, choose one of the following:
  •  Click Docs → then click + Manage Webhooks

Viewing an Advanced Integrated Visibility Tracking Number Subscription Project

1. FedEx Personal Access and Setup

  •  A FedEx Admin or FedEx Representative will initiate the setup process.
  •  The organization profile is created by a designated administrator on behalf of CSP customers.
  •  An eligible U.S.-based billing account number is added at the organization level by the administrator on behalf of the customer.
  •  The administrator performing this setup must have the appropriate permissions to manage organization-level configurations.

2. View Workflow for Tracking Number Subscription

2.1 View the Subscription

  •  Once a FedEx Admin or Representative creates a project, users can view the associated Advanced Integrated Visibility – Tracking Number Subscription Project within their dashboard.

2. View Features

  •  Users can explore the available features associated with the subscription project for better understanding and utilization.

Feature Descriptions

Field Name Description
Proof of Delivery Confirms that a shipment has been successfully delivered. Includes:
  • 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

 

On the Details page, the following information will be displayed:

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-by-Step Process

4. Create a Subscription Project

  •  Use the steps from the previous section or refer to the Getting Started Guide.

5. 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.

6. 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 names 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.
CLOSE

Response

Copy