Business Webhooks Model

ActionMethodResourceDescription
Get allGET/business/:business_id/webhooksGet all webhooks with business_id.
GetGET/business/:business_id/webhooks/:webhook_idGet webhook with id business_id and webhook_id.
Create POST/business/:business_id/webhooksCreate a webhook with business_id.
Update PUT/business/:business_id/webhooks/:webhook_idUpdate webhook with business_idand webhook_id.
Delete DELETE/business/:business_id/webhooks/:webhook_idDelete webhook with business_id and webhook_id.

The webhook model is composed of the following attributes:

AttributeTypeRequiredDescription
hookstringrequiredThe webhook's hook.Yes
urlurlrequiredThe webhook's url.Yes

📘

Restrictions for POST, PUT, DELETE business webhooks.

Business webhooks can only be created, updated or removed by user level 0 (Type: Administrator) and user level 2 (Type: Business owner).

  • User type Administrator can create, update or remove any business webhooks.
  • User type Business owner can create, update or remove only business webhooks related to his business.