Create a Webhook
OAuthScope
ZohoCommerce.webhooks.CREATE
HTTP Request
POST https://commerce.zoho.com/store/api/v1/settings/webhooks
Body Parameters
| Parameter | Values |
| url* | string: URL for the callback when the event triggered. |
| events* | array: An array of strings which represents list of events for which webhook has to be triggered. |
Supported Events
SalesOrder
- salesorder.created
- salesorder.confirmed
- salesorder.cancelled
- salesorder.declined
- salesorder.shipped
- salesorder.delivered
Collections
- collection.created
- collection.edited
Category
- product_category.created
- product_category.edited
Item Group
- itemgroup.created
- itemgroup.edited
Sample Request
Copiedcurl -i -X POST \
-H "Authorization:Zoho-oauthtoken 1000.eb5cd6b42efd0e60a7e5d3cc767c5df0.ae2b687db4827ba2563514d0bf02f2a0" \
-H "X-com-zoho-store-organizationid:682219181" \
-d \
'{ "url":"https://zylkerfashionstore.zohostore.com/callback","events": ["salesorder.created","salesorder.confirmed"]}' \
'https://commerce.zoho.com/store/api/v1/settings/webhooks'Sample Response
Copied{
"code": 0,
"message": "Created Successfully",
"webhook": {
"webhook_id": "1706707000000726002",
"webhook_name": "EventWorkFlow_1581400660",
"description": "",
"url": "https://zylkerfashionstore.zohostore.com/callback",
"entity": "salesorder",
"method": "POST",
"entity_parameters": [
],
"user_defined_format_name": "",
"user_defined_format_value": "%24%7BJSONString%7D",
"additional_parameters": [
],
"headers": [
],
"secret": "",
"events": "[salesorder.confirmed, salesorder.created]"
}
}This API can be used to create webhook.