Fedex Logo

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:

  1. 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.
  2. 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.
  3. 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.

 

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

  • 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.
CLOSE

Response

Copy