How to Manage Tracking Webhooks [Step-by-Step Guide]

Webhooks in techTRACK allow you to automatically notify a Client's external systems when specific shipment-related events occur, such as tracking updates from Carriers. This enables real-time data synchronization with your own platforms.

This article explains how to manage your webhooks using the centralized Tracking Webhooks tab within your Organization settings.

This article is divided into the following sections:

1. Access the Tracking Webhooks Tab
2. Create a New Webhook
3. Work with an Existing Webhook
   1. Edit a Webhook
   2. Delete a Webhook

NOTE: These procedures require special user permissions. To verify your permissions, refer to techTRACK User Permissions Structure [Information].

I. ACCESS THE TRACKING WEBHOOKS TAB

1. Click Organizations from the left menu under the System section.

2. Press View for the desired Organization.

3. Click on the Tracking Webhooks tab.

You will see a list of all existing webhooks for your Organization.

From here, continue to the section that best matches your use case.

II. CREATE A NEW WEBHOOK

From the Tracking Webhooks tab:

1. Press Create.

2. Complete the available fields:

A) Main

• Enabled: Select Yes or No to control whether the webhook is active.
• Name: Enter a user-friendly name to identify the webhook's purpose (e.g., "Customer A - Delivery Notifications").

B) Technical

• URL: Enter the destination endpoint URL where techTRACK will send the webhook payload (the notification data).
• Format: Defines the structure (schema) of the JSON payload:
  • Standard: Uses the techTRACK's standard JSON schema, as detailed in the Standard.json file attached to this article.
  • Legacy: Uses the techTRACK's legacy JSON schema, as detailed in the Legacy.json file attached to this article.
    
    

    WARNING: If your external system has not been updated, changing an existing webhook from the Legacy format to another format may cause backward incompatibility.

     

  • Custom: Allows for a unique payload structure to meet specific integration requirements.

    
    

    WARNING: Before using a Custom format, contact the Techdinamics Support Team and provide your required JSON schema. You can use any of the available fields shown in the attached Standard.json example. Adding new fields is currently not supported.
    
    If you choose Custom, the following fields will appear: Custom Map Definition Code, Custom Map Class Name, and Custom Map Source Name. These are completed by the Techdinamics Support Team. 

     

• Event Type Filter: Restricts triggers to one or more specific event types (e.g., Shipped, In Transit, Delivered). Multiple selections are supported.

• Event Status Filter: Filters events by their criticality level: Info, Warning, or Error. Multiple selections are supported.

• Carrier Filter: Restricts triggers to events generated by one or more specific carriers. Multiple selections are supported.

• For All Accounts: Defines the webhook's scope. Select Yes to apply it to all of the organization's accounts. Select No to choose specific accounts using the Selected Accounts field (multiple selections are supported).

C) Security

This subsection allows you to customize your webhook's HTTP request (for example, to send an API key or token).

Click + to add each customization.

Then, enter the following fields:

• Type: Select Query param to append a query parameter, or Header to add a custom header.
• Name: Enter the parameter or header name (e.g., key for a query parameter, or x-api-key for a header).
• Value: Enter the fixed value to be sent for the specified name.

3. Press Save to create the webhook.

Your webhook is immediately created.

III. WORK WITH AN EXISTING WEBHOOK

From the Tracking Webhooks tab, select the subsection that best suits your case.

NOTE: Use this section to manage webhooks that were configured before this update.

i. Edit a Webhook

1. Press Edit for the webhook you wish to modify.

2. Update the fields as needed.

NOTE: For detailed field descriptions, refer to Section II.

While editing a webhook, you can also review the Created On, Created By, Modified On, and Modified By fields. 

3. Press Save.

Your changes are applied immediately.

ii. Delete a Webhook

1. Press Delete next to the webhook you wish to remove.

2. Click OK.

Your webhook is deleted immediately.