---
title: "SDK: webhooks"
description: "The webhooks methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK: webhooks

{/* Generated by apps/docs/scripts/generate.mjs (SDK pages from the TypeScript types in packages/sdk). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

The `webhooks` area has 6 methods on the client. Each takes one object of path, query and body arguments and an optional `CallOptions`, and returns a promise of the response body. A refused call rejects with `OverlaneApiError` (see the [SDK index](/sdk/)).

## webhooksCreate

Create an outbound webhook; the signing secret is shown once (bots class)

- Request: `POST` on `/v1/tenants/{tenantId}/webhooks`
- Needs an approval for agents: class `bots`

```ts
webhooksCreate(args: { tenantId: string; body: CreateWebhookRequest }, options?: CallOptions): Promise<WebhookCreated>
```

## webhooksDelete

Disable a webhook (bots class)

- Request: `DELETE` on `/v1/tenants/{tenantId}/webhooks/{webhookId}`
- Needs an approval for agents: class `bots`

```ts
webhooksDelete(args: { tenantId: string; webhookId: string }, options?: CallOptions): Promise<WebhookSubscription>
```

## webhooksDeliveries

A webhook's recent deliveries with status, attempts and next attempt

- Request: `GET` on `/v1/tenants/{tenantId}/webhooks/{webhookId}/deliveries`

```ts
webhooksDeliveries(args: { tenantId: string; webhookId: string }, options?: CallOptions): Promise<WebhookDeliveryList>
```

## webhooksList

List outbound webhooks

- Request: `GET` on `/v1/tenants/{tenantId}/webhooks`

```ts
webhooksList(args: { tenantId: string }, options?: CallOptions): Promise<WebhookList>
```

## webhooksRotate

Rotate a webhook's signing secret; shown once (bots class)

- Request: `POST` on `/v1/tenants/{tenantId}/webhooks/{webhookId}/rotate-key`
- Needs an approval for agents: class `bots`

```ts
webhooksRotate(args: { tenantId: string; webhookId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<WebhookCreated>
```

## webhooksTest

Send a test event to a webhook

- Request: `POST` on `/v1/tenants/{tenantId}/webhooks/{webhookId}/test`

```ts
webhooksTest(args: { tenantId: string; webhookId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<WebhookDeliveryList>
```

Source: https://docs.overlane.app/sdk/webhooks/index.mdx