Action | Method | Resource | Description |
---|---|---|---|
Get all | GET | /business/:business_id/webhooks | Get all webhooks with business_id . |
Get | GET | /business/:business_id/webhooks/:webhook_id | Get webhook with id business_id and webhook_id . |
Create | POST | /business/:business_id/webhooks | Create a webhook with business_id . |
Update | PUT | /business/:business_id/webhooks/:webhook_id | Update webhook with business_id and webhook_id . |
Delete | DELETE | /business/:business_id/webhooks/:webhook_id | Delete webhook with business_id and webhook_id . |
The webhook model is composed of the following attributes:
Attribute | Type | Required | Description | |
---|---|---|---|---|
hook | string | required | The webhook's hook. | Yes |
url | url | required | The 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.