When to Use Webhooks
Webhooks usually acts as a messenger for smaller data. It helps to
send and extracting real-time updates.
One of the most suitable scenarios for using a webhook is when your
app or platform requires a real-time feature and you don’t want to use
an API, because you don’t want to get entangled with the setups and
waste resources in the process. In such instances, a webhook framework
will be most beneficial.
Another best use case for using a webhook is where an API isn’t
provided or the available API isn’t best fit to act, a webhook could
be used instead in such a situation.
Webhooks can be regarded as a perfect, and sometimes even essential
complement to API-based application integration.
Here are some outlines from Agility CMS on other use cases of using
Clearing and managing a custom cache in an external system such as a
website, mobile application, or database.Providing a way
to sync content/data for integrations with third-party systems (i.e.
Salesforce, Mailchimp, etc).Building custom content
workflows.Kick-off a CI/D pipeline to redeploy your website when
content has been updated - this is often used for JAMstack sites that
are built using static site generators.
Content Webhooks allow external applications or websites to become
aware of content changes that occur within your Agility CMS instance.
It works by providing a list or URL endpoints to Agility CMS. Each
time content changes or is published in the CMS, Agility will notify
each endpoint of the change and pass-on a message representing the
exact change that occurred.
To get started with a webhook on Agility CMS, please follow
When To Use API
APIs work incredibly well when you’re certain of constant
incremental changes in data. Relatively stagnate data doesn’t need an
API. For example, if you’re an eCommerce store that regularly has to
track data or updating some shipping status, then an API would be the
As you know, to obtain data updates through API, you need to “call”
it regularly. So, one can say that APIs are a great fit for
application integration when you know you will have a constant change
Well, APIs are still popular for several reasons:
Not every application supports webhook integrations.Sometimes you
only want to know about the result, rather than every event (i.e.
every permutation) that’s changed an object.Webhooks can only notify
you about an event, so if you want to make a change based on new
information, you’ll need an API.A webhook payload may not contain
all the data you need about an event, hence an API is used.
Both API’s and webhooks have different use cases, but if your goal
is to transfer data between two services, webhooks are the way to go.
And if your platform or application would demand frequent data
changes, then an API should be used.
You could use both APIs and webhooks together to create a system
that can communicate the right types of data as it suits your