AsyncAPI channel · EasyPost
· EasyPost Webhooks API
webhook
Single delivery channel. EasyPost POSTs an Event payload to the subscriber's configured webhook URL for every event type the account is subscribed to. The specific event type is conveyed by the `description` field of the Event payload.
A batch's status has changed (e.g. label generation progress).
Content-Type: application/json
tracker.created
A Tracker has been created for a tracking code.
Content-Type: application/json
tracker.updated
A Tracker's status or scan history has been updated.
Content-Type: application/json
scan_form.created
A scan form (SCAN form/manifest) has been created.
Content-Type: application/json
scan_form.updated
A scan form's status or contents have been updated.
Content-Type: application/json
refund.successful
A refund request has completed successfully.
Content-Type: application/json
report.new
A new report has been requested and is being generated.
Content-Type: application/json
report.empty
Report generation finished but produced no rows.
Content-Type: application/json
report.available
Report generation completed; CSV is downloadable from `url`.
Content-Type: application/json
report.failed
Report generation failed.
Content-Type: application/json
payment.created
A bank account or credit card has been charged.
Content-Type: application/json
payment.completed
A bank transfer has successfully completed.
Content-Type: application/json
payment.failed
A transfer or charge encountered an issue.
Content-Type: application/json
insurance.purchased
An insurance policy has been purchased for a shipment.
Content-Type: application/json
insurance.cancelled
An insurance policy has been cancelled.
Content-Type: application/json
claims.submitted
A claim has been submitted to EasyPost for processing.
Content-Type: application/json
claims.cancelled
A claim has been cancelled.
Content-Type: application/json
claims.updated
A claim's status or fields have been updated.
Content-Type: application/json
claims.rejected
A claim has been rejected.
Content-Type: application/json
claims.approved
A claim has been approved.
Content-Type: application/json
shipment.invoice.created
A shipment invoice has been created.
Content-Type: application/json
shipment.invoice.updated
A shipment invoice has been updated.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.