Articles on: API & Webhook

Webhook

How does webhook work? (How the data flows from TrackingMore to users via Webhook?)


Webhooks act as a gateway to receive raw data at a particular destination that you define. Webhook is used to ask Trackingmore to push back any updates to your system. This is used when the store wants to send out notifications by themselves or receive the latest delivery status / checkpoint. Users can select when to ask TrackingMore pushes back delivery updates when using webhook.
This requires you to add a webhook URL in our trackingmore developer system. When completing requesting data, Webhook will respond the data to you through your configured URL. You can also understand it like this: you share an endpoint with TrackingMore and TrackingMore will be sending you the payloads in JSON format. And you write a schema to process that and show it on the track page. (The endpoint is the webhook URL)


📢 What you’ll learn

In this tutorial, we’ll discuss:



Setup webhook
  1. Go to TrackingMore Developer > Webhooks
  2. Add Webhook URL & description (4 Webhook URLs max).
  3. Select statuses to start receiving updates (all statuses including info received, in transit, out for delivery, failed attempt, delivered, exception, expired, notfound or specific statuses from all statuses)
    Add webhook URL
    All statuses
    Specific statuses


Update webhook/endpoint
  1. Go to TrackingMore Developer > Webhooks
  2. Click the specific endpoint
  3. Actions > update details: endpoint URL, description, version, statuses > update endpoint
    Go to endpoint details
    Update details
    Update endpoint


Test endpoint
  1. Go to TrackingMore Developer > Webhooks
  2. Click the specific endpoint
  3. Actions > test endpoint
    Go to endpoint details
    Test endpoint


Disable or delete webhook
  1. Go to TrackingMore Developer > Webhooks
  2. Click the specific endpoint
  3. Actions > disable, actions > delete
    Go to endpoint details
    Disable or delete webhook



For more details about Webhook, please refer to this doc: https://www.trackingmore.com/docs/trackingmore/79dpyqt0qaebs-webhook-overview & more sections below:

  1. Webhook secure
  2. Retry webhook
  3. Webhook-Specifications
  4. Webhook outgoing IP


Updated on: 31/08/2023

Was this article helpful?

Share your feedback

Cancel

Thank you!