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.sqs: Direct ingestion into AWS Simple Queue Service.azure_queue: Integration with Azure Storage Queue.pubsub: Integration with Google Cloud Pub/Sub.
Properties
| Property | Type | Description |
|---|---|---|
id | UUID | Stable unique identifier for the feed subscriber. |
created_date | Date | Date when the subscriber was created. |
updated_date | Date | Date when the subscriber was last modified. |
name | String | Human-readable name for the subscriber. |
type | String | Transport type: webhook, sqs, azure_queue, or pubsub. |
state | String | Current operating state: active or paused. |
events | Array | List of event types to deliver (e.g. integration.created, sync.completed). |
configuration | Object | Transport-specific connection parameters (URLs, credentials, queue names). |
application_id | UUID | Identifier of the application 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",
"sync.completed"
],
"configuration": {
"url": "https://api.acmelearning.com/webhooks/edlink",
"secret": "whsec_..."
}
}
