A webhook (also called a web callback or HTTP push API) is a way for an app to provide other applications with real-time information. A webhook delivers data to other applications as it happens, meaning you get data immediately.
Unlike typical APIs where you would need to poll for data very frequently in order to get it real-time.
This makes webhooks much more efficient for both the provider and consumer.
Where to Find Webhooks in OfficeRnD
The section in which webhooks reside can be found in "Settings"->"Developer Tools"->"Webhooks":
From here, you can choose to "Add Endpoint" in order to begin the setup of webhooks.
Setting up WebHooks
When you choose to add an endpoint you'll be able to specify the following:
- Endpoint URL - the endpoint of your server where HTTP POST requests will be made.
- Description - an optional description allowing you to describe the purpose of the webhook.
- Events to send - the list of events for which requests will be made to the endpoint.
Note: For more detailed instructions on how to use webhooks in OfficeRND, please go to our developer article here. There, you'll find a comprehensive guide on the entire setup and all of the necessary information on the topic.
Please sign in to leave a comment.