Integration scopes determine the extent of data that a partner application can access from a company. These scopes control which entities—such as brands, branches, menus, and items—a partner can interact with. Integration scopes ensure that partners only have access to the data necessary for their operations.
When new integration scopes are created, additional entities become accessible to partners. Conversely, destroying integration scopes restricts access to certain entities, preventing partners from fetching new updates or creating orders based on those entities.
For more detailed explanation on integration scopes and how they operate, please refer to the Partner API → Integration Scopes Guides.
Event Types
Integration Scope webhooks can be of any of the following event types:
| Event Type | Description |
|---|---|
| integration_scope.create | A new integration scope got created allowing the partner to fetch and work with new entities |
| integration_scope.destroy | An existing integration scope got destroyed preventing the partner from fetching and working with it's entities anymore, Partners should mark related entities as removed in this case to avoid order failures. |
Application <> Company UninstallationIf a company decided to completely uninstall a partner's application, all integration scopes between this application and the company will be destroyed and a webhook -integration_scope.destroy- for each destroyed integration scope will be sent to the partner application.