Docs

Endpoints list changed

SSE event emitted when the set of endpoints visible to the application in a tenant changes

event: ENDPOINTS_LIST_CHANGED

Emitted when the set of endpoints visible to your application in a tenant changes, or when a visible endpoint's capabilities or routes change. Use it to keep a local cache of tenant endpoints up to date without polling.

This event only fires once your application has at least one endpoint of its own in the tenant. Until that first own endpoint exists, changes to other endpoints in the tenant are not reported, even when an authorization is in place. To bootstrap or refresh the cache outside of this event, call GET /tenants or GET /tenants/{tenantId}/endpoints.

Data fields

FieldTypeRequiredDescription
event_typestring (ENDPOINTS_LIST_CHANGED)yesDiscriminator; matches the event: line.
tenant_idUUIDyesThe tenant whose endpoint list changed.
endpointsarray of TenantEndpointInfoyesComplete current list of endpoints in the tenant that are visible to the application. Replaces any cached list, do not merge.

Each endpoints[] entry carries id, external_id, name, endpoint_type, application_id, tenant_id, owned_by_your_application, capabilities (can_send / can_receive), and, for endpoints owned by your application, routed_endpoints (can_send_to / can_receive_from maps of agrirouter endpoint ID to message types). See GET /tenants/{tenantId}/endpoints for the field-by-field schema.

Sample frame

event: ENDPOINTS_LIST_CHANGED
data: {"event_type":"ENDPOINTS_LIST_CHANGED","tenant_id":"12345678-abcd-ef01-2345-6789abcdef01","endpoints":[{"id":"9f8e7d6c-5b4a-3210-fedc-ba0987654321","external_id":"urn:my-app:endpoint:42","name":"FarmApp user-12345","endpoint_type":"cloud_software","application_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","tenant_id":"12345678-abcd-ef01-2345-6789abcdef01","owned_by_your_application":true,"capabilities":{"can_send":["iso:11783:-10:taskdata:zip"],"can_receive":["iso:11783:-10:taskdata:zip"]},"routed_endpoints":{"can_send_to":{"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee":["iso:11783:-10:taskdata:zip"]},"can_receive_from":{}}}]}

See also

On this page