Skip to main content
PUT
Update Webhook

Authorizations

Authorization
string
header
required

OAuth 2.0 authorization

Path Parameters

id
integer
required

The webhook's unique identifier.

Body

application/json
topic
enum<string>
required

The webhook's topic.

Available options:
return,
label,
restock,
label.request,
giftcard,
happy.returns.shipment
Example:

"return"

trigger
enum<string>
required

The condition which triggers the webhook.

Available options:
return.created,
return.updated,
return.closed,
label.created,
label.updated,
restock.requested,
label.request.issued,
label.request.cancelled,
giftcard.requested,
shipment.processed
Example:

"return.created"

url
string
required

The webhook's URL.

Example:

"https://example.com/webhook"

status
enum<string>
required

The webhook's status.

Available options:
active,
inactive

Response

No Content