Update Webhook

{
  "url": "https://example.com/new-webhook",
  "filterTypes": ["shipment.created", "shipment.cancelled"],
  "description": "Updated production webhook"
}

{
  "id": "ep_2KtRQ8fTStWPKrXP",
  "url": "https://example.com/new-webhook",
  "filterTypes": ["shipment.created", "shipment.cancelled"],
  "active": true,
  "created_at": "2024-01-15T10:00:00Z",
  "description": "Updated production webhook"
}

PUT

api

partner_webhooks

{id}

{
  "url": "https://example.com/new-webhook",
  "filterTypes": ["shipment.created", "shipment.cancelled"],
  "description": "Updated production webhook"
}

{
  "id": "ep_2KtRQ8fTStWPKrXP",
  "url": "https://example.com/new-webhook",
  "filterTypes": ["shipment.created", "shipment.cancelled"],
  "active": true,
  "created_at": "2024-01-15T10:00:00Z",
  "description": "Updated production webhook"
}

Request Parameters

Path Parameters

string

required

Webhook endpoint ID

Request Body

string

New HTTPS URL where webhook events will be sent

array

New list of event types to subscribe to (null to keep existing)

string

New description of the webhook endpoint

{
  "url": "https://example.com/new-webhook",
  "filterTypes": ["shipment.created", "shipment.cancelled"],
  "description": "Updated production webhook"
}

{
  "id": "ep_2KtRQ8fTStWPKrXP",
  "url": "https://example.com/new-webhook",
  "filterTypes": ["shipment.created", "shipment.cancelled"],
  "active": true,
  "created_at": "2024-01-15T10:00:00Z",
  "description": "Updated production webhook"
}

You can also use PATCH /api/partner_webhooks/{id} with the same request body format.

Response Fields

string

Unique identifier for the webhook endpoint

string

HTTPS URL where webhook events are sent

array

Event types this endpoint is subscribed to

boolean

Whether the endpoint is active

string

When the endpoint was created (ISO 8601 format)

string

Description of the webhook endpoint

Shipments

Availability

Webhooks

Request Parameters

Path Parameters

Request Body

Response Fields

​Request Parameters

​Path Parameters

​Request Body

​Response Fields

Request Parameters

Path Parameters

Request Body

Response Fields