Webhook support in datasources

[chrisdevereux]

Re @conatus ' comment on SyncedModel:

One question I do have is what does one do when one doesn't want to sync the data periodically with a Cron. The documentation doesn't answer this directly. We can imagine some cases where the data changes quite rapidly and is important to keep up to date. I presume we somehow override the method, but can't be sure. I don't think this blocks this very good work going in however! Maybe take a ticket to document this situation?

[chrisdevereux]

So, this is actually covered in the API reference, but not in the tutorial. If you pass None as the value of sync_frequency, it won't sync on a cron. This currently is mainly useful if you are only interested in embedded resources returned by the main resource, but could extend to other use cases if we want.

One way we might want to do this (which would be particularly good for fast-changing data) is adding webhook support to datasources. I'm imagining that might look something like this:

# app/urls.py

from django.urls import path, include

urlpatterns = [
    path('webhooks/', include('groundwork.core.webhooks')
]

with datasources then registering themselves so that they can 'push' into features that use them such as SyncedModel rather than being 'pulled' on a schedule.