Skip to main content

Get webhook endpoint by ID

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

This endpoint retrieves detailed information for a specific webhook endpoint including recent delivery history.

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

Response Data:

  • Complete webhook configuration
    • Delivery statistics (total, successful, failed)
    • Recent delivery attempts with timestamps and response codes
    • Enabled/disabled status
    • Created and last updated timestamps

Use Cases:

  • Viewing webhook details and configuration
    • Troubleshooting webhook delivery issues
    • Monitoring webhook health and performance
    • Preparing for webhook updates

Error Scenarios:

  • 404 NOT FOUND - Webhook or store not found (Error code: WEBHOOK_NOT_FOUND or 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 endpoint retrieved successfully with delivery history