Skip to content

Latest commit

 

History

History
118 lines (77 loc) · 4.78 KB

README.md

File metadata and controls

118 lines (77 loc) · 4.78 KB

Webhooks

(webhooks)

Overview

You can configure webhooks to be notified about various events that happen on your instance. https://clerk.com/docs/integration/webhooks

Available Operations

create_svix_app

Create a Svix app and associate it with the current instance

Example Usage

from clerk_backend_api import Clerk

with Clerk(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    res = s.webhooks.create_svix_app()

    if res is not None:
        # handle response
        pass

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.SvixURL

Errors

Error Type Status Code Content Type
models.ClerkErrors 400 application/json
models.SDKError 4XX, 5XX */*

delete_svix_app

Delete a Svix app and disassociate it from the current instance

Example Usage

from clerk_backend_api import Clerk

with Clerk(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    s.webhooks.delete_svix_app()

    # Use the SDK ...

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Errors

Error Type Status Code Content Type
models.ClerkErrors 400 application/json
models.SDKError 4XX, 5XX */*

generate_svix_auth_url

Generate a new url for accessing the Svix's management dashboard for that particular instance

Example Usage

from clerk_backend_api import Clerk

with Clerk(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    res = s.webhooks.generate_svix_auth_url()

    if res is not None:
        # handle response
        pass

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.SvixURL

Errors

Error Type Status Code Content Type
models.ClerkErrors 400 application/json
models.SDKError 4XX, 5XX */*