Documentation / @tenancy-node/transport-webhook / WebhooksApi

Interface: WebhooksApi

Defined in: transport-webhook/src/webhooks.ts:75

Methods

deliveries()

deliveries(endpointId, options?): Promise<WebhookDelivery[]>

Defined in: transport-webhook/src/webhooks.ts:86

Parameters

endpointId

number

options?

limit?

number

status?

"failed" | "success" | "pending" | "dead"

Returns

Promise<WebhookDelivery[]>

---

dispatchOnce()

dispatchOnce(): Promise<{ dead: number; failed: number; sent: number; }>

Defined in: transport-webhook/src/webhooks.ts:94

Returns

Promise<{ dead: number; failed: number; sent: number; }>

---

get()

get(id): Promise<WebhookEndpoint | undefined>

Defined in: transport-webhook/src/webhooks.ts:79

Parameters

id

number

Returns

Promise<WebhookEndpoint | undefined>

---

list()

list(options?): Promise<WebhookEndpoint[]>

Defined in: transport-webhook/src/webhooks.ts:78

Parameters

options?

tenant?

string | null

Returns

Promise<WebhookEndpoint[]>

---

redeliver()

redeliver(deliveryId): Promise<void>

Defined in: transport-webhook/src/webhooks.ts:91

Vuelve a enviar una entrega (por ejemplo, desde dead-letter).

Parameters

deliveryId

number

Returns

Promise<void>

---

register()

register(input): Promise<{ endpoint: WebhookEndpoint; secret: string; }>

Defined in: transport-webhook/src/webhooks.ts:77

Registra un endpoint. El secreto solo se devuelve aquí: guárdalo para verificar las firmas.

Parameters

input

RegisterWebhookInput

Returns

Promise<{ endpoint: WebhookEndpoint; secret: string; }>

---

remove()

remove(id): Promise<void>

Defined in: transport-webhook/src/webhooks.ts:84

Parameters

id

number

Returns

Promise<void>

---

rotateSecret()

rotateSecret(id): Promise<string>

Defined in: transport-webhook/src/webhooks.ts:85

Parameters

id

number

Returns

Promise<string>

---

startDispatcher()

startDispatcher(): object

Defined in: transport-webhook/src/webhooks.ts:95

Returns

object

stop()

stop(): Promise<void>

Returns

Promise<void>

---

test()

test(id): Promise<{ error?: string; ms: number; ok: boolean; status: number | null; }>

Defined in: transport-webhook/src/webhooks.ts:93

Envía un evento webhook.test al endpoint y devuelve el resultado (no se reintenta).

Parameters

id

number

Returns

Promise<{ error?: string; ms: number; ok: boolean; status: number | null; }>

---

update()

update(id, changes): Promise<WebhookEndpoint>

Defined in: transport-webhook/src/webhooks.ts:80

Parameters

id

number

changes

active?

boolean

events?

readonly string[]

name?

string

url?

string

Returns

Promise<WebhookEndpoint>