Skip to Content
eventdoordocs home

API reference

Every operation a scoped API credential can call, with its request and response.

This reference lists every operation that accepts a scoped API credential; no other operation does.

Base URL and authentication

Every path below is relative to your platform's API base URL:

https://<your platform's API host>/eventdoor/api/v1

Copy yours from Settings > Integrations in the admin.

Send your credential as a bearer token on every request:

Authorization: Bearer edk_...

See Authentication for issuing a credential and what each level may do.

Operations

MethodPathWhat it does
GET/organizations/{orgSlug}/hubsList organization hubs
GET/organizations/{orgSlug}/hubs/{hubSlug}Get hub (expand=tree, depth 1-5, default 2)
GET/organizations/{orgSlug}/broadcastsList broadcasts (org-wide)
GET/organizations/{orgSlug}/broadcasts/{broadcastSlug}Get broadcast (org-scoped)
PATCH/organizations/{orgSlug}/broadcasts/{broadcastSlug}Update broadcast (org-scoped)
GET/organizations/{orgSlug}/broadcasts/{broadcastSlug}/changesList who changed a broadcast, newest first
GET/organizations/{orgSlug}/hubs/{hubSlug}/broadcastsList broadcasts in a hub
POST/organizations/{orgSlug}/hubs/{hubSlug}/broadcastsCreate broadcast (201; title required, stored up to 72 characters)
PATCH/organizations/{orgSlug}/hubs/{hubSlug}/broadcasts/bulkBulk update broadcasts (207)
POST/organizations/{orgSlug}/hubs/{hubSlug}/broadcasts/bulk-upsertBulk upsert broadcasts (207)
GET/organizations/{orgSlug}/hubs/{hubSlug}/broadcasts/{broadcastSlug}Get broadcast
PATCH/organizations/{orgSlug}/hubs/{hubSlug}/broadcasts/{broadcastSlug}Update broadcast

The spec

Download the OpenAPI spec to generate a client or import it into your API tool.

Your platform's admin (Settings > Integrations > API reference) opens an interactive copy of this reference, with Try it against your own platform.

On this page

Base URL and authenticationOperationsRelated guidesThe spec
Give feedback