Webhooks
Using Webhooks to Receive API Updates in Anywhere Boards
Webhooks are an invaluable tool that allows you to subscribe to notifications and receive API updates whenever specific events occur in your Anywhere board. These events can include tasks being created, status changes, or assignee modifications. Webhooks can significantly enhance automation and productivity within your workflow.
If you're new to webhooks or need more information, you can learn more about them through this link.
Webhooks differ from API resources in that they represent dynamic resources that automatically notify you when a predefined event takes place in your Anywhere board. The primary concepts associated with webhooks are subscriptions, topics, and notifications.
A subscription allows you to select a specific topic that you wish to receive notifications for. Anywhere will create subscriptions for selected topics when the app is installed on a workspace.
Subscriptions consist of one or more events or topics. Events represent the types of notifications you want to be informed about.
Notifications are objects delivered to a webhook. They contain payloads, which include JSON objects from the API, such as user information or conversations. To receive these notifications, you need to provide a URL where Anywhere will send the requests.
Here's how to set up a webhook:
Expand the Administration sub-menu and click on Webhook Subscriptions. This will take you to the Webhook Subscription screen.
Click on Add New Webhook Subscription, and a pop-up will appear.
Specify the URL where you want to receive requests.
Choose one or more events from the Webhook Events drop-down list.
Provide the Board ID and its value inside the text boxes for Additional Webhook Header and Header Value. Click Add and then Save.
You can find the Board ID for the board you are creating the webhook for in its URL.
Note: It's crucial to provide the Board ID in the additional header parameters for the webhooks to function correctly. Without it, webhooks related to a specific board will not work.
Note: For non-board-related webhooks, such as User Registered or Guest User Registered, you do not need to add the Board_Id parameter.
And that's it! Your webhook is set up. You can view or edit the details of your added webhook subscription by clicking on Details.
We hope this article has provided you with a comprehensive understanding of how to use webhooks in Anywhere. If you have any feedback or further questions, please feel free to let us know. We appreciate your input!
Webhooks are an invaluable tool that allows you to subscribe to notifications and receive API updates whenever specific events occur in your Anywhere board. These events can include tasks being created, status changes, or assignee modifications. Webhooks can significantly enhance automation and productivity within your workflow.
If you're new to webhooks or need more information, you can learn more about them through this link.
Webhooks differ from API resources in that they represent dynamic resources that automatically notify you when a predefined event takes place in your Anywhere board. The primary concepts associated with webhooks are subscriptions, topics, and notifications.
Subscriptions
A subscription allows you to select a specific topic that you wish to receive notifications for. Anywhere will create subscriptions for selected topics when the app is installed on a workspace.
Events/Topics
Subscriptions consist of one or more events or topics. Events represent the types of notifications you want to be informed about.
Notifications
Notifications are objects delivered to a webhook. They contain payloads, which include JSON objects from the API, such as user information or conversations. To receive these notifications, you need to provide a URL where Anywhere will send the requests.
Here's how to set up a webhook:
Expand the Administration sub-menu and click on Webhook Subscriptions. This will take you to the Webhook Subscription screen.
Click on Add New Webhook Subscription, and a pop-up will appear.
Specify the URL where you want to receive requests.
Choose one or more events from the Webhook Events drop-down list.
Provide the Board ID and its value inside the text boxes for Additional Webhook Header and Header Value. Click Add and then Save.
You can find the Board ID for the board you are creating the webhook for in its URL.
Note: It's crucial to provide the Board ID in the additional header parameters for the webhooks to function correctly. Without it, webhooks related to a specific board will not work.
Note: For non-board-related webhooks, such as User Registered or Guest User Registered, you do not need to add the Board_Id parameter.
And that's it! Your webhook is set up. You can view or edit the details of your added webhook subscription by clicking on Details.
We hope this article has provided you with a comprehensive understanding of how to use webhooks in Anywhere. If you have any feedback or further questions, please feel free to let us know. We appreciate your input!
Updated on: 20/09/2023
Thank you!