Skip to content

Push Feeds (Webhooks)

Push feeds deliver collection updates to your system in real-time via webhooks. When content in a collection changes, the Interplai platform sends an HTTP POST to your registered endpoint with the full updated collection data.

How it works

  1. A collection is updated in the Interplai platform (new post added, post removed, etc.)
  2. The platform sends an HTTP POST to every registered webhook endpoint for that collection
  3. Each delivery includes the full collection data, signed with an HMAC-SHA256 signature
  4. Your endpoint receives the request, verifies the signature, and processes the data

Event types

EventDescription
COLLECTION_UPDATEDA collection's contents have changed

What you receive

Each webhook delivery includes:

  • Headers with event type, delivery timestamp, and HMAC signature
  • Body with the event type, collection ID, timestamp, and full collection data

See Webhook Payload for the full format.

Setting up webhooks

Webhooks are managed in your organisation settings on the Interplai platform.

When to use push feeds

  • You need real-time updates as soon as content changes
  • Your system is event-driven (e.g. triggers a graphic update on new content)
  • You want to avoid polling and reduce unnecessary API calls
  • You have a publicly accessible HTTPS endpoint to receive webhooks

For simpler polling-based integrations, see Pull Feeds (REST API).

Interplai API v1.2.0