Skip to main content

Get all webhook endpoints for a store

GET 

/api/v1/sdk/stores/:storeId/webhooks

This endpoint retrieves all configured webhook endpoints for a store with optional filtering by enabled status.

Authentication: Requires Private API Key (sk_*) with Administer permission

Response Data:

  • Webhook ID and URL
    • Subscribed event types
    • Enabled/disabled status
    • Description
    • Delivery statistics (success/failure counts)
    • Created and updated timestamps
    • Secret is NOT included for security (only shown during creation)

Use Cases:

  • Listing all configured webhooks
    • Webhook management dashboards
    • Auditing webhook configurations
    • Finding webhooks to update or delete

Error Scenarios:

  • 404 NOT FOUND - Store not found (Error code: STORE_NOT_FOUND)
    • 401 UNAUTHORIZED - Invalid or missing API key (Error code: INVALID_API_KEY)
    • 403 FORBIDDEN - Insufficient permissions (Error code: INSUFFICIENT_PERMISSIONS)

Request​

Responses​

Webhook endpoints retrieved successfully