List All Webhooks
OAuthScope
ZohoCommerce.webhooks.READ
HTTP Request
GET https://commerce.zoho.com/store/api/v1/settings/webhooks
Body Parameters
| Parameter | Values |
| sort_column | string: name, created_time |
| sort_order | char: A ,D. |
| page | integer: 1 to n |
| per_page | integer: 10,25,50,100,200 |
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 GET \
-H "Authorization:Zoho-oauthtoken 1000.dfc80c76832b0a01a4942e36296d630b.fc34c656cb13e3d6c2f33799fa41468f" \
-H "X-com-zoho-store-organizationid:764593214" \
'https://commerce.zoho.com/store/api/v1/settings/webhooks?sort_order=D&sort_column=created_time'
Sample Response
Copied{
"code": 0,
"message": "success",
"webhooks": [
{
"webhook_id": "2937291000000152012",
"webhook_name": "EventWorkFlow_1640064464",
"description": "",
"placeholder": "",
"is_active": true,
"url": "https://zylkerfashionstore.zohostore.com/callback",
"entity": "salesorder",
"method": "POST",
"created_time": "2021-12-21T09:27:44+0400",
"related_rules": [
{
"workflow_id": "2937291000000152016",
"workflow_name": "EventWorkFlow_1640064464"
}
]
},
{
"webhook_id": "2937291000000152002",
"webhook_name": "EventWorkFlow_1640064433",
"description": "",
"placeholder": "",
"is_active": true,
"url": "https://zylkerfashionstore.zohostore.com/callback",
"entity": "salesorder",
"method": "POST",
"created_time": "2021-12-21T09:27:13+0400",
"related_rules": [
{
"workflow_id": "2937291000000152006",
"workflow_name": "EventWorkFlow_1640064433"
}
]
}
],
"page_context": {
"page": 1,
"per_page": 200,
"has_more_page": false,
"applied_filter": "Entity.All",
"sort_column": "created_time",
"sort_order": "D"
}
}
Show full
Show less