# List Webhook List all registered webhooks GET /api/v3/webhooks Returns: - All registered webhooks for your account - Webhook status (active/inactive) - Event topics subscribed - Delivery URLs Use cases: - Audit webhook configurations - Verify webhook setup - List active event subscriptions Endpoint: GET /api/v3/webhooks Version: v3.0.0 ## Query parameters: - `filter.statuses` (array) Filter by webhook status (e.g., to see only active webhooks) Enum: "STATUS_ACTIVE", 2, "STATUS_INACTIVE", 3 - `filter.store_ids` (array) Filter by store IDs - `filter.team_ids` (array) Filter by team IDs (internal use) - `filter.topics` (array) Filter by event topics Enum: "TOPIC_ORDER_COMPLETED", 2, "TOPIC_ORDER_CANCELLED", 3, "TOPIC_TRACKING_ORDER_UPDATED", 4, "TOPIC_ORDER_ON_HOLD", 5, "TOPIC_SHIPPING_ADDRESS_VERIFIED", 6, "TOPIC_SHIPPING_ADDRESS_UNVERIFIED", 7, "TOPIC_PRODUCT_OUT_OF_STOCK", 8 - `filter.versions` (array) Filter by webhook version Enum: "VERSION_V1", 2, "VERSION_V3", 3 - `filter.webhook_ids` (array) Filter by specific webhook IDs - `paging.limit` (integer) - `paging.page` (integer) ## Response 200 fields (application/json): - `status` (string) Response status: "success" or "error" - `message` (string) Human-readable message - `paging` (object) Pagination metadata - `paging.total` (integer,string) - `paging.total_page` (integer) - `paging.page` (integer) - `paging.limit` (integer) - `data` (array) List of registered webhooks Each webhook includes: ID, topic, delivery URL, status, created_at - `data.webhook_id` (string) Unique webhook ID - `data.topic` (string,number) Event topic this webhook subscribes to Enum: "TOPIC_ORDER_COMPLETED", 2, "TOPIC_ORDER_CANCELLED", 3, "TOPIC_TRACKING_ORDER_UPDATED", 4, "TOPIC_ORDER_ON_HOLD", 5, "TOPIC_SHIPPING_ADDRESS_VERIFIED", 6, "TOPIC_SHIPPING_ADDRESS_UNVERIFIED", 7, "TOPIC_PRODUCT_OUT_OF_STOCK", 8 - `data.status` (string,number) Webhook status (active/inactive) Enum: "STATUS_ACTIVE", 2, "STATUS_INACTIVE", 3 - `data.delivery_url` (string) URL where webhook events will be delivered (HTTPS required) - `data.version` (string,number) Webhook payload version Enum: "VERSION_V1", 2, "VERSION_V3", 3 - `data.created_at` (string) When this webhook was created - `data.updated_at` (string) When this webhook was last updated - `data.team_id` (string) Team ID this webhook belongs to - `data.store_id` (string) Store ID this webhook is scoped to (optional) ## Response 400 fields (application/json): - `code` (string, required) Machine-readable error code Example: "INVALID_ARGUMENT" - `message` (string, required) Human-readable error message Example: "The request parameters are invalid" - `details` (array) Additional error details - `details.field` (string) Field that caused the error - `details.issue` (string) Description of the issue ## Response 401 fields (application/json): - `code` (string, required) Machine-readable error code Example: "INVALID_ARGUMENT" - `message` (string, required) Human-readable error message Example: "The request parameters are invalid" - `details` (array) Additional error details - `details.field` (string) Field that caused the error - `details.issue` (string) Description of the issue ## Response 403 fields (application/json): - `code` (string, required) Machine-readable error code Example: "INVALID_ARGUMENT" - `message` (string, required) Human-readable error message Example: "The request parameters are invalid" - `details` (array) Additional error details - `details.field` (string) Field that caused the error - `details.issue` (string) Description of the issue ## Response 404 fields (application/json): - `code` (string, required) Machine-readable error code Example: "INVALID_ARGUMENT" - `message` (string, required) Human-readable error message Example: "The request parameters are invalid" - `details` (array) Additional error details - `details.field` (string) Field that caused the error - `details.issue` (string) Description of the issue ## Response 500 fields (application/json): - `code` (string, required) Machine-readable error code Example: "INVALID_ARGUMENT" - `message` (string, required) Human-readable error message Example: "The request parameters are invalid" - `details` (array) Additional error details - `details.field` (string) Field that caused the error - `details.issue` (string) Description of the issue