Skip to main content
In addition to setting up webhooks through the dashboard, you can programmatically create and manage webhooks using the Platform API. This is useful for:
  • Automating webhook setup as part of your deployment process
  • Building integrations that dynamically configure webhooks
  • Managing webhooks across multiple shops programmatically

Creating a Webhook

Use the POST /webhooks endpoint to create a new webhook subscription:
The response includes the webhook configuration with its ID and secret key:
Store the secret value securely - you’ll need it to verify webhook signatures.

Complete Example: Create, Receive, and Verify

Here’s a complete flow showing how to set up a webhook programmatically and handle incoming events: Step 1: Create the webhook
Step 2: Receive and verify webhook events

API Endpoints

The Platform API provides these endpoints for webhook management: