Class BoardSubscription

Hierarchy

  • BoardSubscription

Constructors

constructor

Properties

callbackUrl? createdAt? data? id? modifiedAt? status? type?

Constructors

constructor

Properties

Optional callbackUrl

callbackUrl?: string

Indicates the HTTPS URL to which Miro sends a webhook when an event occurs.

Optional createdAt

createdAt?: Date

Date and time when the webhook subscription was created.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

Optional data

data?: BoardSubscriptionData

Optional id

id?: string

Unique identifier (ID) of a webhook subscription.

Optional modifiedAt

modifiedAt?: Date

Date and time when the webhook subscription was last modified.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

Optional status

status?: string = BoardSubscription.StatusEnum.Enabled

Indicates whether the status of the webhook subscription. enabled: Miro sends a webhook when an event occurs in the associated board. disabled: Miro does not send a webhook even when an event occurs in the associated board. lost_access: The user with which the webhook subscription is associated has lost access to the board. The user needs to regain access to the board, and then reenable the webhook subscription by updating the webhook subscription status to enabled by using the update webhook endpoint.

Optional type

type?: string

The type of object associated with the webhook subscription.

@mirohq/miro-api