client.webhooks

client.webhooks — the webhooks operations.

On AsyncKindgi every method is the same, awaited.

client.webhooks.list()

list(
    *,
    limit: int | None = None,
    cursor: str | None = None,
    status: Literal['active', 'paused'] | None = None,
    timeout: float | None = None,
) -> WebhookTriggerCollectionPage

List webhook triggers. GET /v1/webhooks

client.webhooks.register()

register(
    *,
    idempotency_key: str | None = None,
    timeout: float | None = None,
    **fields: Any,
) -> WebhookTriggerRecord

Register a webhook trigger. POST /v1/webhooks

Registers a kind=webhook trigger. The route mints webhookId (a random UUID). Caller must have written the plaintext HMAC secret to /v1/secrets first and passes the resulting name as hmacSecretName — the trigger never stores the plaintext. Rotation flows through POST /v1/secrets/:name/rotate.

client.webhooks.get()

get(*, timeout: float | None = None) -> WebhookTriggerRecord

Fetch a webhook trigger. GET /v1/webhooks/{triggerId}

client.webhooks.update()

update(
    *,
    idempotency_key: str | None = None,
    timeout: float | None = None,
    **fields: Any,
) -> WebhookTriggerRecord

Update a webhook trigger. PATCH /v1/webhooks/{triggerId}

HMAC secret rotation is NOT here — rotate via POST /v1/secrets/:name/rotate on the referenced secret.

client.webhooks.pause()

pause(
    *,
    idempotency_key: str | None = None,
    timeout: float | None = None,
) -> WebhookTriggerRecord

Pause a webhook trigger. POST /v1/webhooks/{triggerId}/pause

client.webhooks.resume()

resume(
    *,
    idempotency_key: str | None = None,
    timeout: float | None = None,
) -> WebhookTriggerRecord

Resume a webhook trigger. POST /v1/webhooks/{triggerId}/resume

client.webhooks.unregister()

unregister(
    *,
    idempotency_key: str | None = None,
    timeout: float | None = None,
) -> WebhookTriggerUnregisterResult

Soft-delete a webhook trigger (tombstone). POST /v1/webhooks/{triggerId}/unregister