Skip to main content
DELETE
Delete webhook

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

id
string
required

Unique identifier for the object.

url
string
required

The URL of the webhook endpoint.

enabledEvents
enum<string>[]
required

The list of events to enable for this endpoint.

Available options:
*,
label.generated,
shipment.updated,
manifest.created,
document.uploaded,
taxes.collection.ready,
taxes.collection.updated,
taxes.collection.cancelled,
taxes.collection.exception,
product.classification.complete,
product.updated
secret
string
required

The endpoint’s secret, used to generate webhook signatures. Only returned at creation.

enabled
boolean
required

The status of the webhook. It can be enabled or disabled.

description
string

An optional description of what the webhook is used for.

metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.