For Developers

Feed Subscribers Overview

Feed Subscribers configure real-time asynchronous event streaming from Edlink to your infrastructure. When school entities or data synchronization events change, Edlink dispatches notifications to your configured destination.

Supported subscriber transports:

  • webhook: HTTPS POST delivery to your web server endpoint.
  • aws_sqs: AWS Simple Queue Service.
  • azure_storage_queue: Azure Storage Queue.
  • google_pubsub: Google Cloud Pub/Sub.

Properties

PropertyTypeDescription
idUUIDStable unique identifier for the feed subscriber.
created_dateDateDate when the subscriber was created.
updated_dateDateDate when the subscriber was last modified.
nameStringHuman-readable name for the subscriber.
typeStringTransport type: webhook, aws_sqs, azure_storage_queue, or google_pubsub.
stateStringactive or inactive.
eventsArrayEvent types to deliver, such as integration.created or materialization.completed.
configurationObjectTransport-specific connection parameters.
applicationObjectApplication that owns this subscriber.

JSON Example

{
    "id": "1c7a216b-4e09-4d24-8f47-c0e815617a22",
    "created_date": "2024-01-15T08:00:00.000Z",
    "updated_date": "2024-06-20T12:00:00.000Z",
    "name": "Production Webhook Dispatcher",
    "type": "webhook",
    "state": "active",
    "events": ["integration.created", "integration.updated", "integration.destroyed"],
    "configuration": {
        "url": "https://api.acmelearning.com/webhooks/edlink",
        "secret": "whsec_..."
    }
}