Event

• A "batch.created" Event is created when the initial creation of a Batch object is complete.
• A "batch.updated" Event is created whenever the status of a Batch object changes.

• An "insurance.purchased" Event is created whenever a standalone Insurance completes purchasing and reporting to the insurer.
• An "insurance.cancelled" Event is created whenever a standalone Insurance fails purchasing, is refunded to your account balance, and is not reported to the insurer.

• A "payment.created" Event is created whenever a bank account or credit card is successfully charged. For credit card charges, this event indicates that the charge is complete and your account balance has already been updated. For bank account transfers (ACH) this indicates the beginning of the transfer process, which may still later fail.
• A "payment.completed" Event is created when a bank account transfer is successfully completed and credited to your account balance. This event indicates that the accounting for that transfer is now complete.
• A "payment.failed" Event is created when a bank account transfer or credit card charge has an issue and cannot be completed. For bank account transfers that fail your account balance may see a failure deduction and an EasyPost could possibly need to get in contact with you about your account status.

• A "refund.successful" Event is created whenever a non-instantaneous Refund request is completed. USPS is the best example of this, as USPS postage takes up to 15 days to be refunded after the initial refund creation.

• A "report.new" Event is created when a Report object is initially created. The report won't be immediately ready for download.
• A "report.empty" Event is created when a Report did not generate because there was no data in the specified date range.
• A "report.available" Event is created when a Report becomes available to download.
• A "report.failed" Event is created when a Report fails to generate.

• A "scan_form.created" Event is created when the initial creation of a ScanForm object is complete.
• A "scan_form.updated" Event is created whenever the status of a ScanForm object changes.

• A "shipment.invoice.created" Event is created when a ShipmentInvoice object is initially created.
• A "shipment.invoice.updated" Event is created if a ShipmentInvoice is adjusted and updated.

• A "tracker.created" Event is created when the initial creation of a Tracker object is complete.
• A "tracker.updated" Event is created whenever a Tracker object gets successfully updated.

{
  "mode": "production",
  "description": "batch.created",
  "previous_attributes": {
    "state": "purchasing"
  },
  "pending_urls": [
    "example.com/easypost-webhook"
  ],
  "completed_urls": [],
  "created_at": "2015-12-03T19:09:19Z",
  "updated_at": "2015-12-03T19:09:19Z",
  "result": {
    "id": "batch_...",
    "object": "Batch",
    "mode": "production",
    "state": "purchased",
    "num_shipments": 1,
    "reference": null,
    "created_at": "2015-12-03T19:09:19Z",
    "updated_at": "2015-12-03T19:09:19Z",
    "scan_form": null,
    "shipments": [
      {
        "batch_status": "postage_purchased",
        "batch_message": null,
        "id": "shp_a5b1348307694736aaqqqq8fqda53f93"
      }
    ],
    "status": {
      "created": 0,
      "queued_for_purchase": 0,
      "creation_failed": 0,
      "postage_purchased": 1,
      "postage_purchase_failed": 0
    },
    "pickup": null,
    "label_url": null
  },
  "id": "evt_...",
  "object": "Event"
}

1curl -X GET https://api.easypost.com/v2/events?page_size=5 \
2  -u "EASYPOST_API_KEY":

1{
2  "events": [
3    {
4      "description": "tracker.created",
5      "id": "evt_5397c3dcba4c11ee99e74d3b807cff5b",
6      "user_id": "user_060ab38db3c04ffaa60f262e5781a9be",
7      "status": "pending",
8      "created_at": "2024-01-24T00:05:47.779Z",
9      "mode": "test",
10      "object": "Event"
11    }
12  ],
13  "has_more": true
14}

1curl -X GET https://api.easypost.com/v2/events/evt_... \
2  -u "EASYPOST_API_KEY":

1{
2  "description": "tracker.created",
3  "mode": "test",
4  "previous_attributes": {},
5  "created_at": "2024-01-24T00:05:48.000Z",
6  "pending_urls": [],
7  "completed_urls": [],
8  "updated_at": "2024-01-24T00:05:48.000Z",
9  "id": "evt_5397c3dcba4c11ee99e74d3b807cff5b",
10  "user_id": "user_060ab38db3c04ffaa60f262e5781a9be",
11  "status": "pending",
12  "object": "Event"
13}