To start sending webhooks to your app, Ecwid needs to know:
- Application name or client_id
- Webhook URL
- Webhook Events
Set webhook URL
After you registered your application with Ecwid, please contact us and provide a single webhook URL for all events your app subscribed to.
Ecwid will send a request to this URL each time a supported event occurs. To enable or change webhook URL for existing application, please contact us as well.
Apps for public use
If your application is for public use, the request URL must be working via HTTPS. Also, the certificate can only be from trusted CA's and not self-signed.
Using ports in webhook URL
If you are planning to use specific ports in your URL, make sure you are using: '80' or '443', or anything between '1024:65535' ports. Otherwise, the webhooks will not be sent to your URL.
Set webhook events
There are several types of events in the store that Ecwid can notify your application about, check out Supported webhook events section for more details.
Please specify the exact event types you wish to be notified about upon registering your application or contact us if you already have an app.
Set custom HTTP headers (optional)
You are also able to specify your custom HTTP headers to be provided by Ecwid when sending webhooks to your URL. If you want to add custom headers to your app, please contact us. Learn more about custom HTTP headers
Get access
Each application requests access scopes from a store owner. The same set of access scopes is used to send webhooks to your app.
To be notified of updates to products, make sure your app has read_catalog access scope. The read_orders scope allows to get order-related webhooks and so on.
See Supported webhook events for more details.
Send us an email with the required details and we will update your application as soon as possible.
Learn more about setting up webhooks below.