Create Webhook

Creates a new Webhook using the parameters passed in the request.

SecurityOAuth2.0
Request
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
201
post/webhooks
Request samples