Interface WebhookEndpoint

Export

WebhookEndpoint

Hierarchy

  • WebhookEndpoint

Properties

account_id: string

The id of the associated account.

Memberof

WebhookEndpoint

created_at: string

Time at which the object was created.

Memberof

WebhookEndpoint

description?: string

An optional description of what the webhook is used for.

Memberof

WebhookEndpoint

The list of events to enable for this endpoint. You may specify [\'*\'] to enable all events.

Memberof

WebhookEndpoint

id: string

Unique identifier for the object.

Memberof

WebhookEndpoint

inactive_at?: null | string

Timestamp of the most recent transition into inactive. Used as the reference date for promoting inactive → disabled: an endpoint must have been continuously inactive for the disabled threshold before it will be disabled. Cleared on any transition out of inactive.

Memberof

WebhookEndpoint

reenabled_at?: null | string

Timestamp of the most recent re-enablement (partner or admin sets status → active/pending). Used as the reference date for health degradation when there is no prior successful delivery.

Memberof

WebhookEndpoint

secret?: string

The endpoint's secret, used to generate webhook signatures. Only returned at creation.

Memberof

WebhookEndpoint

The health status of the endpoint: - active — Normal operation. - pending — Re-enabled and awaiting a successful delivery. - inactive — No successful delivery in 3+ days. Events are queued but delivery is not attempted. - disabled — Has been inactive for 7+ days. Events are unrecoverable.

Memberof

WebhookEndpoint

updated_at: string

Time at which the object was last updated.

Memberof

WebhookEndpoint

url: string

The URL of the webhook endpoint.

Memberof

WebhookEndpoint

Generated using TypeDoc