Webhooks

interface Webhooks

Manages webhook endpoints in the authenticated project.

Inheritors

Functions

Link copied to clipboard
open suspend fun deleteWebhookEndpoint(id: String, requestOptions: RequestOptions? = null): Boolean

Delete an endpoint; returns false when it no longer exists.

Link copied to clipboard
open suspend fun rotateWebhookSecret(id: String, request: WebhookSecretRotation = WebhookSecretRotation(), requestOptions: RequestOptions? = null): WebhookEndpoint

Rotate a signing key, optionally retaining the old key for 24 hours.

Link copied to clipboard
open suspend fun testWebhookEndpoint(id: String, request: WebhookTestRequest, requestOptions: RequestOptions? = null): WebhookTestResult

Send a sample event; inspect the returned statusCode for receiver success.

Link copied to clipboard
open suspend fun updateWebhookEndpoint(id: String, request: WebhookEndpointUpdate, requestOptions: RequestOptions? = null): WebhookEndpoint

Update an endpoint configuration.

Link copied to clipboard
open suspend fun webhookEndpoint(request: WebhookEndpointRequest, requestOptions: RequestOptions? = null): WebhookEndpoint

Create an endpoint; signingSecret is returned only here and during rotation.

open suspend fun webhookEndpoint(id: String, requestOptions: RequestOptions? = null): WebhookEndpoint?

Retrieve endpoint configuration without returning its signing key.

Link copied to clipboard
open suspend fun webhookEndpoints(after: String? = null, limit: Int? = null, requestOptions: RequestOptions? = null): PaginatedList<WebhookEndpoint>

List project endpoints with cursor metadata.