Skip to main content

Get specific webhook subscription

GET 
/v2-experimental/webhooks/subscriptions/:subscription_id

Retrieves information for a specific webhook subscription.

Required scope

boards:read

Rate limiting

Level 2

Request​

Path Parameters

    subscription_id stringrequired

    Unique identifier (ID) of the subscription that you want to retrieve

Responses​

Subscription retrieved

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 that the webhook subscription is associated with.

    oneOf

    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...