Get Webhook

Returns the Webhook object for a valid identifier.

SecurityOAuth2.0
Request
path Parameters
webhook-id
required
string
header Parameters
x-api-key
string
tenant-id
string
Content-Type
string
Default: application/json
Responses
200
get/webhooks/{webhook-id}
Request samples
Response samples
application/json
{
  • "headers": { },
  • "merchants": [
    ],
  • "pickup": { },
  • "dropoff": { },
  • "pickup_partner_location_ids": "string",
  • "dropoff_partner_location_ids": "string",
  • "custom_conditions": [
    ],
  • "config_id": "string",
  • "config_name": "string",
  • "url": "string",
  • "status": "ACTIVE",
  • "entity_type": "Shipment",
  • "notify_label_update": true,
  • "notify_carriyo_label_update": true,
  • "notify_rma_received_items": true,
  • "notify_rma_returned_items": true,
  • "notify_status": [
    ],
  • "initial_retry_frequency": 0,
  • "max_retry_count": 0,
  • "internal": true,
  • "update_date": "string"
}