Question

Where can I find exhaustive list of all Webhook events supported by REST API?

  • 6 August 2023
  • 6 replies
  • 63 views

Badge +1

I am making a Miro app that uses REST API.

I want to handle all events in my app thus want to know list of all webhook event types.


6 replies

Userlevel 6
Badge +4

Hi @Mohammed Sameer,

Thanks for reaching out about this, and good question. At the moment, we haven’t published an exhaustive list of every possible event type and JSON payload for our Webhooks, but you raise a great point. We will work on providing more sample payloads in our documentation.

In the meantime, you might find it helpful to set up a test endpoint to retrieve JSON payloads that you can reference. We’ve provided a guide for setting up a test endpoint in Pipedream, which makes it easy to view the JSON payloads, if you’re interested:
Set up a test endpoint

One of the main payload types at the moment, which you may also find helpful:

Item created

{
"body": {
"eventType": "board_subscription",
"event": {
"boardId": "{{boardId}}",
"item": {
"id": "{{id}}",
"type": "sticky_note",
"createdAt": "2023-08-07T09:14:53Z",
"createdBy": {
"id": "{{id}}",
"type": "user"
},
"data": {
"content": "",
"shape": "square"
},
"geometry": {
"width": 107.46000000000001,
"height": 123.12
},
"modifiedAt": "2023-08-07T09:14:53Z",
"modifiedBy": {
"id": "{{id}}",
"type": "user"
},
"position": {
"x": -793.7911764208224,
"y": -557.1289197010661,
"origin": "center",
"relativeTo": "canvas_center"
},
"style": {
"fillColor": "light_yellow",
"textAlign": "CENTER",
"textAlignVertical": "middle"
}
},
"type": "create"
},
"eventTime": "2023-08-07T09:14:53Z",
"appId": {{id}},
"users": [
{{id}}
]
}
}

I hope this helps, and thanks for the feedback that documenting all payload types will be helpful. We will work on this for the future!

Best,
Will

Badge +1

I have already setup an endpoint, so presently the only way is to run different actions on Miro boards to found out what event do they emit? 
I hope the product considers to provide exhaustive list on priority.

Best,

Sameer.

Userlevel 6
Badge +4

Hi @Mohammed Sameer,

Thanks a lot for raising the importance of this—I can certainly understand. At the moment, that’s correct. However, it’s a great point, and we will work on adding more payload details to our docs.

Thanks,
​​​​​​​Will

Badge +1

 

Badge +1

 

Userlevel 3
Badge +1

Hi @Mohammed Sameer and anyone else interested in setting up webhooks for Miro:

I know it’s a bit late but I’ve created a video tutorial on how to set up webhooks and a quick demo of how the webhook events will look like when they’ve been implemented. 

Hope it helps! 

Reply