Skip to main content

Create webhook subscription

POST 
/v2-experimental/webhooks/board_subscriptions

Creates a webhook subscription to receive notifications when an item on a board is updated. Subscriptions are created per user, per board. You can create multiple subscriptions. We currently support all board items barring tags, connectors, and comments. Changes in item position do not trigger an event at the moment.

Required scope

boards:read

Rate limiting

Level 2

Request​

Body

required

    boardId string

    Unique identifier (ID) of the board that you want to associate with the webhook subscription.

    callbackUrl string

    Possible values: >= 8 characters and <= 256 characters, Value must match regular expression ^https:\/\/(.*)

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

    status string

    Possible values: [enabled, disabled]

    Default value: 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.

Responses​

Subscription created

Schema

    callbackUrl string

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

    createdAt date-time

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

    data

    object

    Contains information about a webhook subscription, such as the board ID associated with the webhook subscription, the date and time when the webhook subscription was last updated, and the type of board item that the subscription is associated with.

    boardId string

    Unique identifier (ID) of the board with which the webhook subscription is associated.

    id string

    Unique identifier (ID) of a webhook subscription.

    modifiedAt date-time

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

    status string

    Possible values: [enabled, disabled, lost_access]

    Default value: 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.

    type string

    The type of object associated with the webhook subscription.

Loading...