Fedex Logo

CREATE A
WEBHOOK MANAGE WEBHOOKS

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:

  1. Select My Projects on the left Navigation Panel.
  2. Select Advanced Integrated Visibility tab.
  3. Select Individual Webhook listed under My Advanced Integrated Visibility.
  4. Select Edit action from the kebab menu (⋮) on the respective Advanced Integrated Visibility.
  5. On the Configure Advanced Integrated Visibility page:
    1. 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).
    2. 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.
  6. On the Enter Details page, select the field(s) you would like to edit and select Next.
  7. 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.
  8. 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).
Note:
  1. Subscription ID associated with an existing Advanced Integrated Visibility webhook remains un-changed when a customer edits/updates the Advanced Integrated Visibility(s).
  2. It will take 10 minutes for the updated changes of an existing Advanced Integrated Visibility webhook to go into effect.
  3. 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).
  4. When an account is associated to a Advanced Integrated Visibility webhook, FedEx will push events happening for new shipments created thereafter for that account.
  5. 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:

  1. Select My Projects on the left Navigation Panel.
  2. Select Advanced Integrated Visibility tab.
  3. Select Individual Advanced Integrated Visibility listed under My Advanced Integrated Visibility.
  4. 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  
  • API key
  • Security Key
Project details Billing Details
  • Billing Account Number
  • Billing Start date
  • Billing Account Number
  • Billing Start date
Project Details
  • Project Status
  • Project Name
  • Destination URL
  • Security token
  • Subscription ID
  • Payload Language
  • Tracking type
  • Email Address
  • Email Language
  • Version
  • Project Status
  • Project Name
  • Destination URL
  • Security token
  • Subscription ID
  • Payload Language
  • Tracking type
  • Email Address
  • Email Language
  • Version
Features Selected
  • Retry policy
  • Proof of delivery
  • Estimated delivery
  • Tracking events
  • Event based filtering
  • Retry policy
  • Proof of delivery
  • Estimated delivery
  • Tracking events
Project history History Detail
  • It shows the history of when the Advanced Integrated Visibility webhook was edited and by which project member.
  • It shows the history of when the Advanced Integrated Visibility webhook was edited and by which project member.
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:

  1. Select My Projects on the left Navigation Panel.
  2. Select Advanced Integrated Visibility tab.
  3. Select Individual Advanced Integrated Visibility listed under My Advanced Integrated Visibility.
  4. Select CANCEL action from the kebab menu (⋮) on the respective Advanced Integrated Visibility.
  5. 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:

  1. Select My Projects on the left Navigation Panel.
  2. Select Advanced Integrated Visibility tab.
  3. Select Individual Advanced Integrated Visibility webhook listed under My Advanced Integrated Visibility.
  4. Select Delete action from the kebab menu (⋮) on the respective Advanced Integrated Visibility.
  5. 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 .

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

Response

Copy