Skip to content

Latest commit

 

History

History
97 lines (60 loc) · 3.3 KB

README.md

File metadata and controls

97 lines (60 loc) · 3.3 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

CreateSvixApp

Create a Svix app and associate it with the current instance

Example Usage

using Clerk.BackendAPI;
using Clerk.BackendAPI.Models.Components;

var sdk = new ClerkBackendApi(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.Webhooks.CreateSvixAppAsync();

// handle response

Response

CreateSvixAppResponse

Errors

Error Type Status Code Content Type
Clerk.BackendAPI.Models.Errors.ClerkErrors 400 application/json
Clerk.BackendAPI.Models.Errors.SDKError 4XX, 5XX */*

DeleteSvixApp

Delete a Svix app and disassociate it from the current instance

Example Usage

using Clerk.BackendAPI;
using Clerk.BackendAPI.Models.Components;

var sdk = new ClerkBackendApi(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.Webhooks.DeleteSvixAppAsync();

// handle response

Response

DeleteSvixAppResponse

Errors

Error Type Status Code Content Type
Clerk.BackendAPI.Models.Errors.ClerkErrors 400 application/json
Clerk.BackendAPI.Models.Errors.SDKError 4XX, 5XX */*

GenerateSvixAuthURL

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

Example Usage

using Clerk.BackendAPI;
using Clerk.BackendAPI.Models.Components;

var sdk = new ClerkBackendApi(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.Webhooks.GenerateSvixAuthURLAsync();

// handle response

Response

GenerateSvixAuthURLResponse

Errors

Error Type Status Code Content Type
Clerk.BackendAPI.Models.Errors.ClerkErrors 400 application/json
Clerk.BackendAPI.Models.Errors.SDKError 4XX, 5XX */*