Skip to main content
WEBHOOK
batch
{
  "test": true,
  "data": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.goshippo.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
default:ShippoToken
required

API key authentication using the ShippoToken scheme. Format: Authorization: ShippoToken <API_TOKEN> Example: Authorization: ShippoToken shippo_live_abc123

Body

application/json

Batch created or purchased

Content of the webhook posted to the external URL

​
event
enum<string>

Type of event that triggered the webhook.

Available options:
transaction_created,
transaction_updated,
track_updated,
batch_created,
batch_purchased,
all
​
test
boolean

Determines whether the webhook is a test webhook or not.

​
data
string

A string containing the batch object ID, of the form 'batch {batchId} (created|processing complete)'.

Response

200

The data was successfully received