Update Webhook

Updates the specified Webhook by setting the values of the parameters passed. All parameters are updated, so any parameters not provided will be cleared.

SecurityOAuth2.0
Request
path Parameters
webhook-id
required
string
header Parameters
x-api-key
string
tenant-id
string
Content-Type
string
Default: application/json
Request Body schema: */*
headers
object
merchants
Array of strings
pickup
object
dropoff
object
pickup_partner_location_ids
string
dropoff_partner_location_ids
string
custom_conditions
Array of objects
config_name
required
string
url
required
string
status
string
Enum: "ACTIVE" "INACTIVE"
entity_type
string
Enum: "Shipment" "ReverseShipment" "ReturnRequest"
notify_label_update
boolean
notify_carriyo_label_update
boolean
notify_rma_received_items
boolean
notify_rma_returned_items
boolean
notify_status
Array of strings
initial_retry_frequency
integer
max_retry_count
integer
internal
boolean
Responses
200
put/webhooks/{webhook-id}
Request samples