Skip to content

Commit

Permalink
formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
horeaporutiu committed Aug 29, 2024
1 parent 6782e7b commit 536dfdc
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions examples/node-webhooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,25 +55,25 @@ ngrok http 3000

This will give you your MIRO_REDIRECT_URL to be used in the `.env` file and then later when calling the API to create a webhook subscription.

5. Create a new Miro app [developers.miro.com](https://developers.miro.com/). This will take you to the app settings page. There you will find the `MIRO_CLIENT_ID` and `MIRO_CLIENT_SECRET` to be added to your `.env` file. Ensure that `boards:read` scope is checked, and then go ahead and install the app on your developer team. You will get an access token which you will need later to authenticate the creation of your webhook subscription.
4. Create a new Miro app [developers.miro.com](https://developers.miro.com/). This will take you to the app settings page. There you will find the `MIRO_CLIENT_ID` and `MIRO_CLIENT_SECRET` to be added to your `.env` file. Ensure that `boards:read` scope is checked, and then go ahead and install the app on your developer team. You will get an access token which you will need later to authenticate the creation of your webhook subscription.

on Rename the `.sample.env` file to `.env` and then add in your `MIRO_CLIENT_ID` and `MIRO_CLIENT_SECRET` from your [developers.miro.com](https://developers.miro.com/) app settings page. Use the `forwarding URL` from the previous step to replace the `<YOUR_DOMAIN.COM>` section of the `MIRO_REDIRECT_URL` in the .env file. Save the file as `.env` with your new variables.

6. Go to your developer team, and open the board you want to receive webhook events for.
5. Go to your developer team, and open the board you want to receive webhook events for.

7. In a separate browser tab, open up the API Exporer for the [Create Webhook Subscription endpoint](https://developers.miro.com/reference/create-board-subscription).
6. In a separate browser tab, open up the API Exporer for the [Create Webhook Subscription endpoint](https://developers.miro.com/reference/create-board-subscription).

8. Provide the following information in the API Explorer:
7. Provide the following information in the API Explorer:

**Access Token**: Once you get the access token after installing your app on a developer team, you can add the access token to the Authorization section of the API reference page.
> **Access Token**: Once you get the access token after installing your app on a developer team, you can add the access token to the Authorization section of the API reference page.
>
> **boardId:** Get the board ID of the board you want to receive notifications for. This board should be in the same team where you installed the app. You can find board ID in the URL when you go to your board: https://miro.com/app/board/{boardID}.
>
> **callbackUrl:** This is the URL where you will receive events. It needs to be publicly accessible - something like "<YOUR_DOMAIN.COM>/auth/miro/callback/"
**boardId:** Get the board ID of the board you want to receive notifications for. This board should be in the same team where you installed the app. You can find board ID in the URL when you go to your board: https://miro.com/app/board/{boardID}.
8. Select Try It! to run the API request right from the browser. If you get a 201 response, you are ready to receive events!

**callbackUrl:** This is the URL where you will receive events. It needs to be publicly accessible - something like "<YOUR_DOMAIN.COM>/auth/miro/callback/"

9. Select Try It! to run the API request right from the browser. If you get a 201 response, you are ready to receive events!

10. Next, go to to the same board which you referenced in the request above, and create a sticky. You should now receive a webhook event! To learn more about the events you can expect to receive,
9. Next, go to to the same board which you referenced in the request above, and create a sticky. You should now receive a webhook event! To learn more about the events you can expect to receive,

https://github.com/horeaporutiu/app-examples-template/assets/10428517/b23d9c4c-e785-43f9-a72e-fa5d82c7b019

Expand Down

0 comments on commit 536dfdc

Please sign in to comment.