Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

EasyPost Webhooks API

Asynchronous Event delivery surface. EasyPost POSTs Event objects to subscriber URLs whenever asynchronous objects (batches, trackers, scan forms, refunds, reports, payments, claims, insurance, shipment invoices) change state. Each delivery is signed with an HMAC-SHA256 signature in the X-Hmac-Signature header, derived from a per-webhook secret. Subscribers must return a 2XX status code; non-2XX responses are retried.

EasyPost Webhooks API is one of 11 APIs that EasyPost publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Webhooks, Events, AsyncAPI, and HMAC. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

This event API exposes 1 operation across 1 channel, and defines 25 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.

The API connects through a single server, {webhook_url} (https).

1 operations 1 channels 25 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0.0
Base URL
https://api.easypost.com/v2
Resource Areas
1

Channels & Operations 1

Across 1 channel, the API surfaces 1 operation. Each is listed below with its action, channel, parameters, and response codes.

Channels 1
PUB
webhook
Receive an EasyPost Event
receiveEasyPostEvent body

Messages & Schemas 25

The contract defines 25 schemas that model the data carried by its messages. The most detailed are Event (12 properties), WebhookHeaders (4 properties). Each schema is shown below with its type and property counts.

BatchCreated
message
Initial batch object creation has completed.
BatchUpdated
message
A batch's status has changed (e.g. label generation progress).
TrackerCreated
message
A Tracker has been created for a tracking code.
TrackerUpdated
message
A Tracker's status or scan history has been updated.
ScanFormCreated
message
A scan form (SCAN form/manifest) has been created.
ScanFormUpdated
message
A scan form's status or contents have been updated.
RefundSuccessful
message
A refund request has completed successfully.
ReportNew
message
A new report has been requested and is being generated.
ReportEmpty
message
Report generation finished but produced no rows.
ReportAvailable
message
Report generation completed; CSV is downloadable from url.
ReportFailed
message
Report generation failed.
PaymentCreated
message
A bank account or credit card has been charged.
PaymentCompleted
message
A bank transfer has successfully completed.
PaymentFailed
message
A transfer or charge encountered an issue.
InsurancePurchased
message
An insurance policy has been purchased for a shipment.
InsuranceCancelled
message
An insurance policy has been cancelled.
ClaimsSubmitted
message
A claim has been submitted to EasyPost for processing.
ClaimsCancelled
message
A claim has been cancelled.
ClaimsUpdated
message
A claim's status or fields have been updated.
ClaimsRejected
message
A claim has been rejected.
ClaimsApproved
message
A claim has been approved.
ShipmentInvoiceCreated
message
A shipment invoice has been created.
ShipmentInvoiceUpdated
message
A shipment invoice has been updated.
WebhookHeaders
object
HTTP headers EasyPost sends with each webhook POST. The X-Hmac-Signature header carries the HMAC-SHA256 signature computed over the raw JSON request body using…
4 properties 2 required
Event
object
EasyPost Event object delivered to webhook subscribers. The same shape is returned by the Events REST API, except result is populated when delivered via webhoo…
12 properties 7 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

easypost-webhooks-asyncapi.yml Raw ↑

Other APIs EasyPost publishes across the network.

EasyPost Shipping API
EasyPost Tracking API
EasyPost Insurance & Claims API
EasyPost Reports API
EasyPost Addresses API
EasyPost Parcels API
EasyPost Refunds API
EasyPost Reports API
EasyPost Shipments API
EasyPost Trackers API