WebHooks¶

Endpoints of the WebHooks section of the iikoCloud API documentation.

Webhooks¶

Webhook notifications.

iiko.webhooks.settings() `async` ¶

settings(
    *, organization_id: str, timeout: float | None = None
) -> GetWebHookSettingsResponse

Get webhooks settings for specified organization and authorized API login.

POST /api/1/webhooks/settings

Restriction group: Organizations: settings.

Parameters:

Name	Type	Description	Default
`organization_id`	`str`	Organization UOC Id. Can be obtained by `/api/1/organizations` operation.	required
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`GetWebHookSettingsResponse`	The `GetWebHookSettingsResponse` response.

iikoCloud API reference

iiko.webhooks.update_settings() `async` ¶

update_settings(
    *,
    organization_id: str,
    web_hooks_uri: str,
    auth_token: str | None = None,
    web_hooks_filter: WebHooksFilter
    | Mapping[str, Any]
    | None = None,
    timeout: float | None = None,
) -> CorrelationIdResponse

Update webhooks settings for specified organization and authorized API login.

POST /api/1/webhooks/update_settings

Restriction group: WebHooks: settings.