Class: WebhooksResource

Defined in: rine-ts-sdk/src/resources/webhooks.ts:22

Constructors

Constructor

new WebhooksResource(http): WebhooksResource;

Defined in: rine-ts-sdk/src/resources/webhooks.ts:23

Parameters

Parameter	Type
http	SDKHttpClient

Returns

WebhooksResource

Methods

create()

create(
   agentId, 
   url, 
   opts?): Promise<{
  active: boolean;
  agent_id: string;
  created_at: string;
  id: string;
  secret: string;
  url: string;
}>;

Defined in: rine-ts-sdk/src/resources/webhooks.ts:31

Register a webhook.

Route: POST /webhooks with body {agent_id, url, events?}. agent_id is required by the server schema.

Parameters

Parameter	Type
agentId	AgentUuid
url	string
opts	{ events?: readonly string[]; signal?: AbortSignal; }
opts.events?	readonly string[]
opts.signal?	AbortSignal

Returns

Promise\<{ active: boolean; agent_id: string; created_at: string; id: string; secret: string; url: string; }>

---

delete()

delete(id): Promise<void>;

Defined in: rine-ts-sdk/src/resources/webhooks.ts:81

Parameters

Parameter	Type
id	WebhookUuid

Returns

Promise\<void>

---

deliveries()

deliveries(id, opts?): Promise<CursorPage<{
  attempts: number;
  created_at: string;
  delivered_at?: string | null;
  id: string;
  last_error?: string | null;
  max_attempts: number;
  message_id: string;
  next_attempt_at?: string | null;
  status: string;
  webhook_id: string;
}>>;

Defined in: rine-ts-sdk/src/resources/webhooks.ts:85

Parameters

Parameter	Type
id	WebhookUuid
opts	{ limit?: number; offset?: number; signal?: AbortSignal; status?: "failed" | "pending" | "processing" | "delivered" | "dead"; }
opts.limit?	number
opts.offset?	number
opts.signal?	AbortSignal
opts.status?	"failed" | "pending" | "processing" | "delivered" | "dead"

Returns

Promise\<CursorPage\<{ attempts: number; created_at: string; delivered_at?: string | null; id: string; last_error?: string | null; max_attempts: number; message_id: string; next_attempt_at?: string | null; status: string; webhook_id: string; }>>

---

deliverySummary()

deliverySummary(id, opts?): Promise<{
  dead: number;
  delivered: number;
  failed: number;
  pending: number;
  processing: number;
  total: number;
}>;

Defined in: rine-ts-sdk/src/resources/webhooks.ts:111

Aggregated delivery counts for a webhook.

Route: GET /webhooks/{id}/deliveries/summary.

Parameters

Parameter	Type
id	WebhookUuid
opts	{ signal?: AbortSignal; }
opts.signal?	AbortSignal

Returns

Promise\<{ dead: number; delivered: number; failed: number; pending: number; processing: number; total: number; }>

---

list()

list(opts?): Promise<CursorPage<{
  active: boolean;
  agent_id: string;
  created_at: string;
  id: string;
  url: string;
}>>;

Defined in: rine-ts-sdk/src/resources/webhooks.ts:46

Parameters

Parameter	Type
opts	{ agentId?: AgentUuid; includeInactive?: boolean; signal?: AbortSignal; }
opts.agentId?	AgentUuid
opts.includeInactive?	boolean
opts.signal?	AbortSignal

Returns

Promise\<CursorPage\<{ active: boolean; agent_id: string; created_at: string; id: string; url: string; }>>

---

update()

update(id, opts): Promise<{
  active: boolean;
  agent_id: string;
  created_at: string;
  id: string;
  url: string;
}>;

Defined in: rine-ts-sdk/src/resources/webhooks.ts:69

Toggle a webhook's active flag.

Body restricted to {active} per server schema.

Parameters

Parameter	Type
id	WebhookUuid
opts	{ active: boolean; signal?: AbortSignal; }
opts.active	boolean
opts.signal?	AbortSignal

Returns

Promise\<{ active: boolean; agent_id: string; created_at: string; id: string; url: string; }>