Skip to main content
POST
/
api
/
partner_webhooks
{
  "url": "https://example.com/webhook",
  "filterTypes": ["shipment.created", "shipment.address.updated", "pickup.completed"],
  "description": "Production webhook endpoint"
}

{
  "id": "ep_2KtRQ8fTStWPKrXP",
  "url": "https://example.com/webhook",
  "filterTypes": ["shipment.created", "shipment.address.updated", "pickup.completed"],
  "active": true,
  "created_at": "2024-01-15T10:00:00Z",
  "description": "Production webhook endpoint",
  "secret": "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"
}

​
Request Body

​
url
string
required
HTTPS URL where webhook events will be sent
​
filterTypes
array
List of event types to subscribe to (empty means all events)
​
description
string
Description of the webhook endpoint
​
secret
string
Base64 encoded secret for webhook signatures (optional, will be generated if not provided)
{
  "url": "https://example.com/webhook",
  "filterTypes": ["shipment.created", "shipment.address.updated", "pickup.completed"],
  "description": "Production webhook endpoint"
}

{
  "id": "ep_2KtRQ8fTStWPKrXP",
  "url": "https://example.com/webhook",
  "filterTypes": ["shipment.created", "shipment.address.updated", "pickup.completed"],
  "active": true,
  "created_at": "2024-01-15T10:00:00Z",
  "description": "Production webhook endpoint",
  "secret": "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"
}
The webhook secret is only returned during creation. Store it securely as it won’t be retrievable later.

​
Response Fields

​
id
string
Unique identifier for the webhook endpoint
​
url
string
HTTPS URL where webhook events are sent
​
filterTypes
array
Event types this endpoint is subscribed to
​
active
boolean
Whether the endpoint is active (always true on creation)
​
created_at
string
When the endpoint was created (ISO 8601 format)
​
description
string
Description of the webhook endpoint
​
secret
string
Webhook signing secret (only shown during creation)