Use case / Tracking

Tracking Update

Webhook for tracking updates.

Push to the endpoint to update tracking information for a resource.

Security

BasicAuthWebhookCredentials

Bodyapplication/jsonrequired

updatesArray of objects(Updates)

List of tracking updates to process

POST

/v1/webhook/tracking-update

{
  "updates": [
    { … }
  ]
}

Successful Response

Bodyapplication/json

Any of:

Response schema for the tracking update webhook. This schema is used to return errors or success messages.

errorsArray of objects or null(Errors)

Any of:

List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.

Response

{
  "errors": {
    "error_message": "The payload is invalid.",
    "error_type": "USER_INPUT_ERROR"
  }
}