Improve API Documentation

Posted almost 2 years by S├ębastien Gicquel

Post a topic
Answered
S
S├ębastien Gicquel

Hello,


Could you please improve API Documentation with more explanations / definitions and concrete examples of use cases ?


I'm a web developper, used to code every day, but not an Agendize specialist.


For example, if you see this page :


https://developers.agendize.com/v2/watchers/reference/index.jsp


What is a Watchers ? (ok, I see "The Watchers API empowers you to watch your client interactions." but what does it mean precisely ?


What is the purpose of this API ? Is it possible to have concrete example like the one we see in the forum ? These examples are perfect to understand the use of the API.


Hope this request could helps you to build a better documentation and helps other developers.

0 Votes

Julien Pauthier

Julien Pauthier posted almost 2 years Admin Best Answer

Hello,


Watchers enable you to notify a third-party server when a specific event happens with your Agendize account. For instance, you can create a watcher for a company's appointments, so that each new appointment will be posted to the third-party server with the JSON structure of the appointment. It works as a webhook triggered when an event occurs.


To give it a test, you can create such watcher using our PHP code sample that creates a new watcher: https://agendize.freshdesk.com/support/discussions/topics/4000341695. You can use webhook.site to create an URL that will collect all new appointments sent by the watcher: webhook.site service will help you see how the watcher works, and see all appointment created sent over by the watcher.


I hope this help!

Please let me know,

Julien


0 Votes


1 Comments

Julien Pauthier

Julien Pauthier posted almost 2 years Admin Answer

Hello,


Watchers enable you to notify a third-party server when a specific event happens with your Agendize account. For instance, you can create a watcher for a company's appointments, so that each new appointment will be posted to the third-party server with the JSON structure of the appointment. It works as a webhook triggered when an event occurs.


To give it a test, you can create such watcher using our PHP code sample that creates a new watcher: https://agendize.freshdesk.com/support/discussions/topics/4000341695. You can use webhook.site to create an URL that will collect all new appointments sent by the watcher: webhook.site service will help you see how the watcher works, and see all appointment created sent over by the watcher.


I hope this help!

Please let me know,

Julien


0 Votes

Login or Sign up to post a comment