Class WebhookEndpoint

A webhook endpoint.

Hierarchy (View Summary)

Entity<WebhookEndpointData>
- WebhookEndpoint

Index

Constructors

Properties

Accessors

createdAt data displayName hasSigningSecret id isActive isDeleted signingKid targetUrl tenantId updatedAt webhookRef

Methods

delete deliveries reload rotateSecret setActive update

Constructors

constructor

new WebhookEndpoint(
options: EntityOptions<WebhookEndpointData>,
): WebhookEndpoint
Parameters
- options: EntityOptions<WebhookEndpointData>
  The client, path, backing data, and delete state.
Returns WebhookEndpoint
Inherited from Entity.constructor
- Defined in entity.ts:46

Properties

`Protected` `Readonly`client

client: AdminClient

The client used to issue requests for this entity.

`Protected` `Readonly`path

path: string

The client-relative path of this resource.

Accessors

createdAt

get createdAt(): string
Creation timestamp.

Returns string
- Defined in webhook-endpoints/entity.ts:62

data

get data(): D
The raw wire record backing this entity.

Returns D
Inherited from Entity.data
- Defined in entity.ts:58

displayName

get displayName(): string
Human-readable name.

Returns string
- Defined in webhook-endpoints/entity.ts:37

hasSigningSecret

get hasSigningSecret(): boolean
Whether a signing secret is stored.

Returns boolean
- Defined in webhook-endpoints/entity.ts:52

id

get id(): string
Endpoint identifier.

Returns string
- Defined in webhook-endpoints/entity.ts:22

isActive

get isActive(): boolean
Whether the endpoint is active.

Returns boolean
- Defined in webhook-endpoints/entity.ts:57

isDeleted

get isDeleted(): boolean
Whether this entity has been deleted through this instance.

Local state only; not authoritative server state.

Returns boolean
Inherited from Entity.isDeleted
- Defined in entity.ts:69

signingKid

get signingKid(): string
The signing key identifier.

Returns string
- Defined in webhook-endpoints/entity.ts:47

targetUrl

get targetUrl(): string
The HTTPS target URL.

Returns string
- Defined in webhook-endpoints/entity.ts:42

tenantId

get tenantId(): string
Owning tenant identifier.

Returns string
- Defined in webhook-endpoints/entity.ts:27

updatedAt

get updatedAt(): string
Last-update timestamp.

Returns string
- Defined in webhook-endpoints/entity.ts:67

webhookRef

get webhookRef(): string
Immutable webhook reference.

Returns string
- Defined in webhook-endpoints/entity.ts:32

Methods

delete

delete(): Promise<boolean>
Deletes this resource.

Idempotent per instance: once this instance has deleted the resource, further calls are a local no-op.

Returns Promise<boolean>
true once the resource has been deleted through this instance.

Throws
ApiException When the control plane returns a non-success status.
Inherited from Entity.delete
- Defined in entity.ts:84

deliveries

deliveries(): WebhookDeliveriesClient
Accesses this endpoint's delivery history.

Returns WebhookDeliveriesClient
A client for delivery operations.
- Defined in webhook-endpoints/entity.ts:158

reload

reload(options?: RequestOptions): Promise<WebhookEndpoint>
Re-fetches this endpoint.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<WebhookEndpoint>
A fresh snapshot.

Throws
NotFoundException When the endpoint is no longer visible.
- Defined in webhook-endpoints/entity.ts:80

rotateSecret

rotateSecret(options?: RequestOptions): Promise<IssuedWebhookEndpoint>
Rotates the endpoint signing secret.

The response carries the new one-time secret; store it immediately.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<IssuedWebhookEndpoint>
The endpoint with its new signing secret.
- Defined in webhook-endpoints/entity.ts:145

setActive

setActive(isActive: boolean, options?: RequestOptions): Promise<WebhookEndpoint>
Activates or deactivates the endpoint.
Parameters
- isActive: boolean
  Whether the endpoint should be active.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<WebhookEndpoint>
The updated endpoint.
- Defined in webhook-endpoints/entity.ts:123

update

update(
request: UpdateWebhookEndpointRequest,
options?: RequestOptions,
): Promise<WebhookEndpoint>
Replaces the endpoint name and target URL.
Parameters
- request: UpdateWebhookEndpointRequest
  The new name and target URL.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<WebhookEndpoint>
The updated endpoint.

Throws
Error When a field fails local validation.
- Defined in webhook-endpoints/entity.ts:100