Interface WebhookEndpointUpdateParams

Export

WebhookEndpointUpdateParams

Hierarchy

  • WebhookEndpointUpdateParams

Properties

description? enabled_events? status? url?

Properties

Optional description

description?: string

An optional description of what the webhook is used for.

Memberof

WebhookEndpointUpdateParams

Optional enabled_events

enabled_events?: WebhookEndpointUpdateParamsEnabledEvents

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

Memberof

WebhookEndpointUpdateParams

Optional status

status?: "active"

Set to active to re-enable an inactive or disabled endpoint. The endpoint transitions to pending and is promoted to active automatically after the first successful delivery.

Memberof

WebhookEndpointUpdateParams

Optional url

url?: string

The URL of the webhook endpoint.

Memberof

WebhookEndpointUpdateParams

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc