Skip to Main Content

Answering Your Biggest Questions About the OnTask API

We are so excited to share our new OnTask API with you. With a new product like this, we know there are always new questions that pop up that need to be answered. So, we’ve been listening, and have broken down the answers to your burning questions.

OnTask API FAQs:

Q: What is the difference between a webhook and an API?
A: Developers use APIs to make requests of the application they are calling. They receive a response to that API request and have logic to process the response. 

Webhooks are similar, but they basically skip the request part. So, a webhook allows a developer to say “here’s a URL, send a message to it when ____ happens”. 

An example of this we can use for OnTask API would be getting a signed document. With an API, the calling application requests the status of the document from OnTask. OnTask responds telling the application “this document hasn’t been signed yet”, and then the application waits and asks again “what about now”. 

Once the OnTask response indicates that the document has been signed, another API is called to download the document. With a webhook, that same application goes “hey, send the document here once it has been signed” so when the document is signed, OnTask’s webhook automatically sends them the document.

Q: What warrants an API integration versus a webhook integration?
A: APIs are more granular and allow the calling application to poll OnTask and make decisions based on what is returned. One example use of an API that isn’t in a webhook would be to check the status of a document or workflow.

Q: What integration allows my company to send documents to my HRIS in addition to data collected by an OnTask workflow?
A: Either an API or a webhook. 

Q: Does OnTask receive data/documents from an API integration as well as send them?
A: Yes.

Q: With the API packages, do I get the same features and support as the Enterprise plan?
A: Yes, you do get the same level of support, as well as 10 hours of services that can be used to help you get up and running quickly with a workflow that can be called via the APIs.

If you didn’t see your question on this list or need more information about OnTask API, please reach out to us here. Someone from our support team will be happy to answer any of your questions or give you a quick demo if your question is a little more complex.