Skip to main content

Get webhook subscriptions

GET 
/v2-experimental/webhooks/subscriptions

Retrieves information about all webhook subscriptions for a specific user.

Required scope

boards:read

Rate limiting

Level 4

Request​

Query Parameters

    limit string

    Possible values: >= 1 and <= 100

    Default value: 10

    cursor string

Responses​

Subscriptions retrieved

Schema

    cursor string

    A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next set of results of the collection, set the cursor parameter in your next request to the value returned in this parameter.

    data

    object[]

    Contains the result data.

  • Array [

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

  • ]

    • limit int32

    Maximum number of results returned based on the limit specified in the request. For example, if there are 20 results, the request has no cursor value, and the limit is set to 20,the size of the results will be 20. The rest of the results will not be returned. To retrieve the rest of the results, you must make another request and set the appropriate value for the cursor parameter value that you obtained from the response.

    size int32

    Number of results returned in the response considering the cursor and the limit values sent in the request. For example, if there are 20 results, the request does not have a cursor value, and the limit set to 10, the size of the results will be 10.
    In this example, the response will also return a cursor value that can be used to retrieve the next set of 10 remaining results in the collection.

    total int64

    Total number of results available. If the value of the total parameter is higher than the value of the size parameter, this means that there are more results that you can retrieve. To retrieve more results, you can make another request and set the offset value accordingly. For example, if there are 30 results, and the request has the offset set to 0 and the limit set to 20, the size parameter will return 20 and the total parameter will return 30. This means that there are 9 more results to retrieve (as the offset is zero-based).

Loading...