Tracking event payload example

{
  "subscription_type": "shipment_tracking",
  "payload": [
    {
      "shipment_id": 115,
      "tracking_number": "9400109205328003425036",
      "tracking_event_id": 539,
      "parcel_id": 115,
      "code": "01",
      "secondary_code": "01",
      "description": "Delivered, In/At Mailbox",
      "event_timestamp": "2018-11-13T00:00:00.000Z",
      "city": "New Oceane",
      "state": "CA",
      "postal_code": "34668-2801",
      "country": "US"
    },
    {
      "shipment_id": 115,
      "tracking_number": "9400109205328003425036",
      "tracking_event_id": 540,
      "parcel_id": 115,
      "code": "OF",
      "secondary_code": null,
      "description": "Out for Delivery",
      "event_timestamp": "2018-11-12T19:00:24.000Z",
      "city": "Lake Jett",
      "state": "LA",
      "postal_code": "91251-7728",
      "country": "US"
    }
  ]
}

code and secondary_code vary by carrier. For USPS the codes are documented in Publication 199, Appendix G-4 (https://postalpro.usps.com/impbimplementationguide).

Payment status event payload example

{
  "subscription_type": "payment_status",
  "payload": [
    {
      "payment_method_id": 0,
      "payment_transaction_id": 0,
      "gateway_txn_reference": "string",
      "transaction_time": "2020-05-14T15:56:58.550Z",
      "amount": 0,
      "type": "string",
      "status": "string"
    }
  ]
}
Log in to see full request history
Body Params
string
required

Subscription type

string
required
Defaults to active

Subscription status. Events are delivered as soon as possible when status is active.

string
required

A secure (HTTPS) web address

string
required
Defaults to json

Format of payloads.

string
required

Approach used for authenticating requests.

string

Shared secret used to sign webhook payloads when auth_type is HMAC.

string

Used for webhook calls when auth_type is HTTP_BASIC.

string

Used for webhook calls when auth_type is HTTP_BASIC.

Response

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json