Skip to content

katana_public_api_client.api.webhook.create_webhook

katana_public_api_client.api.webhook.create_webhook

Classes

Functions

asyncio(*, client, body) async

Create a webhook

Creates a new webhook object.

Parameters:

  • body (CreateWebhookRequest) –

    Request payload for creating a new webhook subscription to receive real-time event notifications Example: {'url': 'https://api.customer.com/webhooks/katana', 'subscribed_events': ['sales_order.created', 'sales_order.delivered', 'current_inventory.product_out_of_stock', 'manufacturing_order.done'], 'description': 'ERP integration webhook for inventory and order sync'}.

Raises:

  • UnexpectedStatus –

    If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • TimeoutException –

    If the request takes longer than Client.timeout.

Returns:

Source code in katana_public_api_client/api/webhook/create_webhook.py 
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
async def asyncio(
    *,
    client: AuthenticatedClient | Client,
    body: CreateWebhookRequest,
) -> DetailedErrorResponse | ErrorResponse | Webhook | None:
    """Create a webhook

     Creates a new webhook object.

    Args:
        body (CreateWebhookRequest): Request payload for creating a new webhook subscription to
            receive real-time event notifications Example: {'url':
            'https://api.customer.com/webhooks/katana', 'subscribed_events': ['sales_order.created',
            'sales_order.delivered', 'current_inventory.product_out_of_stock',
            'manufacturing_order.done'], 'description': 'ERP integration webhook for inventory and
            order sync'}.

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        Union[DetailedErrorResponse, ErrorResponse, Webhook]
    """

    return (
        await asyncio_detailed(
            client=client,
            body=body,
        )
    ).parsed

asyncio_detailed(*, client, body) async

Create a webhook

Creates a new webhook object.

Parameters:

  • body (CreateWebhookRequest) –

    Request payload for creating a new webhook subscription to receive real-time event notifications Example: {'url': 'https://api.customer.com/webhooks/katana', 'subscribed_events': ['sales_order.created', 'sales_order.delivered', 'current_inventory.product_out_of_stock', 'manufacturing_order.done'], 'description': 'ERP integration webhook for inventory and order sync'}.

Raises:

  • UnexpectedStatus –

    If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • TimeoutException –

    If the request takes longer than Client.timeout.

Returns:

Source code in katana_public_api_client/api/webhook/create_webhook.py 
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
async def asyncio_detailed(
    *,
    client: AuthenticatedClient | Client,
    body: CreateWebhookRequest,
) -> Response[DetailedErrorResponse | ErrorResponse | Webhook]:
    """Create a webhook

     Creates a new webhook object.

    Args:
        body (CreateWebhookRequest): Request payload for creating a new webhook subscription to
            receive real-time event notifications Example: {'url':
            'https://api.customer.com/webhooks/katana', 'subscribed_events': ['sales_order.created',
            'sales_order.delivered', 'current_inventory.product_out_of_stock',
            'manufacturing_order.done'], 'description': 'ERP integration webhook for inventory and
            order sync'}.

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        Response[Union[DetailedErrorResponse, ErrorResponse, Webhook]]
    """

    kwargs = _get_kwargs(
        body=body,
    )

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

sync(*, client, body)

Create a webhook

Creates a new webhook object.

Parameters:

  • body (CreateWebhookRequest) –

    Request payload for creating a new webhook subscription to receive real-time event notifications Example: {'url': 'https://api.customer.com/webhooks/katana', 'subscribed_events': ['sales_order.created', 'sales_order.delivered', 'current_inventory.product_out_of_stock', 'manufacturing_order.done'], 'description': 'ERP integration webhook for inventory and order sync'}.

Raises:

  • UnexpectedStatus –

    If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • TimeoutException –

    If the request takes longer than Client.timeout.

Returns:

Source code in katana_public_api_client/api/webhook/create_webhook.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
def sync(
    *,
    client: AuthenticatedClient | Client,
    body: CreateWebhookRequest,
) -> DetailedErrorResponse | ErrorResponse | Webhook | None:
    """Create a webhook

     Creates a new webhook object.

    Args:
        body (CreateWebhookRequest): Request payload for creating a new webhook subscription to
            receive real-time event notifications Example: {'url':
            'https://api.customer.com/webhooks/katana', 'subscribed_events': ['sales_order.created',
            'sales_order.delivered', 'current_inventory.product_out_of_stock',
            'manufacturing_order.done'], 'description': 'ERP integration webhook for inventory and
            order sync'}.

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        Union[DetailedErrorResponse, ErrorResponse, Webhook]
    """

    return sync_detailed(
        client=client,
        body=body,
    ).parsed

sync_detailed(*, client, body)

Create a webhook

Creates a new webhook object.

Parameters:

  • body (CreateWebhookRequest) –

    Request payload for creating a new webhook subscription to receive real-time event notifications Example: {'url': 'https://api.customer.com/webhooks/katana', 'subscribed_events': ['sales_order.created', 'sales_order.delivered', 'current_inventory.product_out_of_stock', 'manufacturing_order.done'], 'description': 'ERP integration webhook for inventory and order sync'}.

Raises:

  • UnexpectedStatus –

    If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • TimeoutException –

    If the request takes longer than Client.timeout.

Returns:

Source code in katana_public_api_client/api/webhook/create_webhook.py 
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def sync_detailed(
    *,
    client: AuthenticatedClient | Client,
    body: CreateWebhookRequest,
) -> Response[DetailedErrorResponse | ErrorResponse | Webhook]:
    """Create a webhook

     Creates a new webhook object.

    Args:
        body (CreateWebhookRequest): Request payload for creating a new webhook subscription to
            receive real-time event notifications Example: {'url':
            'https://api.customer.com/webhooks/katana', 'subscribed_events': ['sales_order.created',
            'sales_order.delivered', 'current_inventory.product_out_of_stock',
            'manufacturing_order.done'], 'description': 'ERP integration webhook for inventory and
            order sync'}.

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        Response[Union[DetailedErrorResponse, ErrorResponse, Webhook]]
    """

    kwargs = _get_kwargs(
        body=body,
    )

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)