Customer server API

Provision a room (idempotent on external_ref)

Requires rooms:write. The room is created in the key's tenant (a test key's sandbox) and has no members; add them with POST /v1/server/rooms/{room_id}/members. With external_ref the call is idempotent per tenant: repeating it returns the existing room unchanged and ignores the other fields. Without external_ref, every call creates a new room. e2ee and e2ee_scheme (mls or megolm, which requires e2ee: true) are set at creation and cannot change. expires_at is informational only: nothing closes or deletes the room when it passes.

provisionRoom · scope rooms:write captured live

Request

curl -X POST https://api.ollacore.com/v1/server/rooms \
  -H "Authorization: Bearer ak_live_…" \
  -H "Content-Type: application/json" \
  -d '{"created_by":"alice","external_ref":"order-7781"}'

{
  "created_by": "alice",
  "external_ref": "order-7781"
}

Request fields

Response · 200

{
  "id": "25964f12-9ae9-4356-80e8-69bc5f749bd1",
  "tenant_id": "acct_fac91b282191cc02dd29912c8db43f1c",
  "external_ref": "order-7781",
  "created_by": "alice",
  "status": "active",
  "e2ee": false,
  "created_at": "2026-01-15T09:30:03Z"
}

Fetch a room

Requires rooms:read. A room in another tenant, a room that does not exist and a room being erased all return 404. status is active or closed. expires_at is informational only.

getRoom · scope rooms:read captured live

Request

curl -X GET https://api.ollacore.com/v1/server/rooms/25964f12-9ae9-4356-80e8-69bc5f749bd1 \
  -H "Authorization: Bearer ak_live_…"

Response · 200

{
  "id": "25964f12-9ae9-4356-80e8-69bc5f749bd1",
  "tenant_id": "acct_fac91b282191cc02dd29912c8db43f1c",
  "external_ref": "order-7781",
  "created_by": "alice",
  "status": "active",
  "e2ee": false,
  "created_at": "2026-01-15T09:30:03Z"
}

Erase a room — rows and blobs

Marks the room deleting and asynchronously purges its object-store blobs, then the stored copies of its events (webhook deliveries, pending fan-out and push work), then cascades the row delete. Requires scope rooms:delete.

deleteRoom · scope rooms:delete captured live

Request

curl -X DELETE https://api.ollacore.com/v1/server/rooms/0e56d494-4ac9-490d-9b2c-58b50ab02ac0 \
  -H "Authorization: Bearer ak_live_…"

Response · 200

{
  "deleting": true
}

Add or restore a member (409 once the room holds 5,000)

A room holds at most 5,000 active members, on every plane; once it is full the add is refused with 409 and nothing changes. Restoring a removed member or changing an existing member's role never needs a seat.

addRoomMember · scope members:write captured live

Request

curl -X POST https://api.ollacore.com/v1/server/rooms/25964f12-9ae9-4356-80e8-69bc5f749bd1/members \
  -H "Authorization: Bearer ak_live_…" \
  -H "Content-Type: application/json" \
  -d '{"principal_id":"alice","role":"owner"}'

{
  "principal_id": "alice",
  "role": "owner"
}

Request fields

Response · 200

{
  "tenant_id": "acct_fac91b282191cc02dd29912c8db43f1c",
  "room_id": "25964f12-9ae9-4356-80e8-69bc5f749bd1",
  "principal_id": "alice",
  "role": "owner",
  "joined_at": "2026-01-15T09:30:03Z"
}

Remove a member

Requires members:write. Sets the membership's left_at; the room's history is kept, and adding the principal again restores the membership. The removal takes effect at once: the member's live chat and RTC sockets close with 4403, and their HTTP requests and new session tokens are refused. A durable member.removed event goes to the room's connected clients and to webhooks subscribed to it. E2EE clients use this event as the cue to rotate keys. 404 if the principal is not an active member.

removeRoomMember · scope members:write captured live

Request

curl -X DELETE https://api.ollacore.com/v1/server/rooms/25964f12-9ae9-4356-80e8-69bc5f749bd1/members/carol \
  -H "Authorization: Bearer ak_live_…"

Response · 200

{
  "removed": true
}

Silence the room's push for a member — 8h, 1w or always (members:write)

Silence push notifications from this room for one member — eight hours, one week, or until unmuted — on behalf of a user whose settings your own server holds (a turnkey-directory user does this for themselves with PUT /v1/directory/conversations/{room_id}/mute). Push only: live delivery and call rings are unaffected, and no event is emitted. Requires members:write.

muteRoomMember · scope members:write captured live

Request

curl -X PUT https://api.ollacore.com/v1/server/rooms/25964f12-9ae9-4356-80e8-69bc5f749bd1/members/bob/mute \
  -H "Authorization: Bearer ak_live_…" \
  -H "Content-Type: application/json" \
  -d '{"duration":"8h"}'

{
  "duration": "8h"
}

Request fields

Response · 200

{
  "tenant_id": "acct_fac91b282191cc02dd29912c8db43f1c",
  "room_id": "25964f12-9ae9-4356-80e8-69bc5f749bd1",
  "principal_id": "bob",
  "role": "member",
  "joined_at": "2026-01-15T09:30:03Z",
  "muted_until": "2026-01-15T17:30:03Z"
}

Unmute (idempotent)

Push notifications again for this member. Idempotent. Requires members:write.

unmuteRoomMember · scope members:write captured live

Request

curl -X DELETE https://api.ollacore.com/v1/server/rooms/25964f12-9ae9-4356-80e8-69bc5f749bd1/members/bob/mute \
  -H "Authorization: Bearer ak_live_…"

Response · 200

{
  "tenant_id": "acct_fac91b282191cc02dd29912c8db43f1c",
  "room_id": "25964f12-9ae9-4356-80e8-69bc5f749bd1",
  "principal_id": "bob",
  "role": "member",
  "joined_at": "2026-01-15T09:30:03Z"
}

Pin which simulcast layer of a publisher's track the member receives — low, medium, high or auto (members:write)

Which simulcast layer of which publisher's track this member should receive, chosen by your server instead of by the adaptive policy — a "pin this speaker in high quality" control. The whole list is replaced: an entry with layer: auto clears that track, an empty list clears everything. Each entry is keyed the way the member's client already sees the track: the publisher's principal id and the publisher's own track id, exactly the stream id and track id a chatbox.msid-principal socket reads off the msid. low, medium and high name the publisher's layers by measured bitrate (with two layers medium is the dearer); a pinned layer that stops is replaced by the dearest live layer below it and taken back when it returns. Applied on the media loop's next layer report, within about a second, to every connection the member has; the size cap the adaptive policy applies in large calls does not apply to a pin. Held for the member's session: a member who is not in the call yet, or whose last connection just closed, keeps the list for a 30 s grace, so a PeerConnection rebuild finds it and a member who left for good does not. Requires members:write.

setMemberPreferences · scope members:write captured live

Request

curl -X PUT https://api.ollacore.com/v1/server/rooms/25964f12-9ae9-4356-80e8-69bc5f749bd1/members/bob/preferences \
  -H "Authorization: Bearer ak_live_…" \
  -H "Content-Type: application/json" \
  -d '{"tracks":[{"publisher":"alice","track_id":"cam-alice","layer":"high"}]}'

{
  "tracks": [
    {
      "publisher": "alice",
      "track_id": "cam-alice",
      "layer": "high"
    }
  ]
}

Request fields

Response · 200

{
  "principal_id": "bob",
  "in_call": false,
  "tracks": [
    {
      "publisher": "alice",
      "track_id": "cam-alice",
      "layer": "high"
    }
  ]
}

What is pinned for the member, and whether they are in the call (rooms:read)

What is pinned for this member right now and whether they are in the call. An empty list for a member with no preference, which is every member by default. Requires rooms:read.

getMemberPreferences · scope rooms:read captured live

Request

curl -X GET https://api.ollacore.com/v1/server/rooms/25964f12-9ae9-4356-80e8-69bc5f749bd1/members/bob/preferences \
  -H "Authorization: Bearer ak_live_…"

Response · 200

{
  "principal_id": "bob",
  "in_call": false,
  "tracks": [
    {
      "publisher": "alice",
      "track_id": "cam-alice",
      "layer": "high"
    }
  ]
}

Restrict what the member may publish and receive, which peers it sees, how many devices it may bring, and its chat and attachment rights — revisioned, live within about a second (members:write)

Replace the member's media policy — what they may publish and receive, who they see in the roster, plus the chat and attachment rights the same token would otherwise carry. A policy is a RESTRICTION set: effective rights are token ∩ the member's current role ∩ this document, never more. Whole-document replacement under the revision rules: a higher revision is stored; the same revision with an identical document (subscribe.publishers compared as a set) is a no-op; the same revision with a different document is 409 revision_conflict; a lower revision is 409 stale_revision — both carry current_revision. The sequence is monotonic for the member's lifetime: a DELETE leaves its revision as a tombstone the next PUT must exceed. Enforced where every request already checks membership: the next HTTP request, and the chat and RTC sockets within about a second (the member's live sockets are told within this request and re-read the row; the chat socket's 30-second recheck remains the fallback). Each enforcement reads role and policy from one membership-row snapshot: a role raised later cannot grant beyond the token, a role lowered removes rights on this same schedule. On the RTC socket a publication the policy refuses is answered inactive and reported as a structured error event; the offer completes normally. Stored on the membership row, so it survives removal and restoration; DELETE is the only way back to role-only behaviour. Requires members:write.

setMemberRtcPolicy · scope members:write captured live

Request

curl -X PUT https://api.ollacore.com/v1/server/rooms/25964f12-9ae9-4356-80e8-69bc5f749bd1/members/alice/rtc-policy \
  -H "Authorization: Bearer ak_live_…" \
  -H "Content-Type: application/json" \
  -d '{"revision":3,"publish":{"audio":false,"video":true,"max_audio_tracks":0,"max_video_tracks":1},"subscribe":{"mode":"allowlist","publishers":["host"]},"chat":{"send":false,"history":false},"attachments":{"upload":false,"download":false}}'

{
  "revision": 3,
  "publish": {
    "audio": false,
    "video": true,
    "max_audio_tracks": 0,
    "max_video_tracks": 1
  },
  "subscribe": {
    "mode": "allowlist",
    "publishers": [
      "host"
    ]
  },
  "chat": {
    "send": false,
    "history": false
  },
  "attachments": {
    "upload": false,
    "download": false
  }
}

Request fields

Response · 200

{
  "principal_id": "alice",
  "stored_revision": 3,
  "applied_revision": null,
  "applied": false,
  "applied_at": null,
  "in_call": false,
  "active_legs": 0,
  "applied_legs": 0,
  "subscribe_enforced": true,
  "enforcement": {
    "publish": {
      "supported": true,
      "requested": true,
      "applied_revision": null
    },
    "capabilities": {
      "supported": true,
      "requested": true,
      "applied_revision": 3
    },
    "subscribe": {
      "supported": true,
      "requested": true,
      "applied_revision": null
    },
    "roster": {
      "supported": true,
      "requested": false,
      "applied_revision": null
    },
    "devices": {
      "supported": true,
      "requested": false,
      "applied_revision": null
    }
  },
  "policy": {
    "revision": 3,
    "publish": {
      "audio": false,
      "video": true,
      "max_audio_tracks": 0,
      "max_video_tracks": 1
    },
    "subscribe": {
      "mode": "allowlist",
      "publishers": [
        "host"
      ]
    },
    "chat": {
      "send": false,
      "history": false
    },
    "attachments": {
      "upload": false,
      "download": false
    }
  }
}

The member's stored policy and how far it has reached their live connections, per component (rooms:read)

The stored document with stored_revision, and the engine's view of the member's live legs: applied_revision is the revision every active leg runs (null with no leg — nothing live to apply, the stored revision applies at the next registration), applied is whether it equals the stored one, active_legs and applied_legs show a change still landing. 404 for a member with no policy: a policy that exists restricts, one that does not does not, and a reconciler must be able to tell the two apart. Requires rooms:read.

getMemberRtcPolicy · scope rooms:read captured live

Request

curl -X GET https://api.ollacore.com/v1/server/rooms/25964f12-9ae9-4356-80e8-69bc5f749bd1/members/alice/rtc-policy \
  -H "Authorization: Bearer ak_live_…"

Response · 200

{
  "principal_id": "alice",
  "stored_revision": 3,
  "applied_revision": null,
  "applied": false,
  "applied_at": null,
  "in_call": false,
  "active_legs": 0,
  "applied_legs": 0,
  "subscribe_enforced": true,
  "enforcement": {
    "publish": {
      "supported": true,
      "requested": true,
      "applied_revision": null
    },
    "capabilities": {
      "supported": true,
      "requested": true,
      "applied_revision": 3
    },
    "subscribe": {
      "supported": true,
      "requested": true,
      "applied_revision": null
    },
    "roster": {
      "supported": true,
      "requested": false,
      "applied_revision": null
    },
    "devices": {
      "supported": true,
      "requested": false,
      "applied_revision": null
    }
  },
  "policy": {
    "revision": 3,
    "publish": {
      "audio": false,
      "video": true,
      "max_audio_tracks": 0,
      "max_video_tracks": 1
    },
    "subscribe": {
      "mode": "allowlist",
      "publishers": [
        "host"
      ]
    },
    "chat": {
      "send": false,
      "history": false
    },
    "attachments": {
      "upload": false,
      "download": false
    }
  }
}

Back to role-only rights — a write in the same revision sequence, ?revision= required (members:write)

Back to token ∩ current role from the next evaluation, on the same schedule as a policy change. A deletion is a write in the same revision sequence as PUT: revision (required) must be above the stored one and becomes the row's tombstone — 409 stale_revision below the stored revision, 409 revision_conflict at it, both carrying current_revision. Optionally If-Match: "<revision>" states the revision you believe is stored; if it is not, 409 revision_conflict with the actual one and nothing changes. After deletion GET answers 404; a retry of the same deletion (same revision) answers 204 again with no further effect, a DELETE below the tombstone is 409 stale_revision, and one above it is 404 policy_deleted carrying the tombstone as current_revision. The If-Match check and the write are one atomic step, so a concurrent PUT cannot slip between them. The next PUT must exceed the tombstone (at it: revision_conflict; below it: stale_revision; both report the tombstone as current_revision) — so a delayed write allocated before the deletion can never bring an obsolete policy back. The sequence never restarts for the member's lifetime. 404 when the member has no policy. Requires members:write.

deleteMemberRtcPolicy · scope members:write captured live

Request

curl -X DELETE https://api.ollacore.com/v1/server/rooms/25964f12-9ae9-4356-80e8-69bc5f749bd1/members/alice/rtc-policy?revision=4 \
  -H "Authorization: Bearer ak_live_…"

Response · 204

Empty body.

Who receives whose media in the call right now, with the simulcast layer (rooms:read)

The SFU's forwarding table for the room right now: each publishing connection, its tracks, and every connection each track is forwarded to (with the simulcast layer). Lets your server reconcile what its RTC policies intend against what is actually flowing. Read from the room's media thread at request time; in_call: false with no publishers when nobody is in the call. 503 not_ready if the media thread does not answer within two seconds — retry. Requires rooms:read.

getRoomForwarding · scope rooms:read captured live

Request

curl -X GET https://api.ollacore.com/v1/server/rooms/25964f12-9ae9-4356-80e8-69bc5f749bd1/rtc/forwarding \
  -H "Authorization: Bearer ak_live_…"

Response · 200

{
  "room_id": "25964f12-9ae9-4356-80e8-69bc5f749bd1",
  "in_call": false,
  "publishers": []
}

Close one of a member's call connections (4413), keeping the membership — their other devices stay in (members:write)

Closes exactly one of a member's RTC connections. The connection is closed with WebSocket code 4413 reason connection_closed, and the answer is 204 only once its media has been retired from the SFU (nothing it published is forwarded, nothing is forwarded to it) — not merely once a close was requested. 503 not_ready if that has not happened within three seconds: retry, and a 404 then means it finished. 404 when the id is not a live connection of this room. The member stays a member and the same token can join again; to stop a member altogether, remove them. Requires members:write.

closeRtcConnection · scope members:write from schema placeholder credentials

Request

curl -X DELETE https://api.ollacore.com/v1/server/rooms/25964f12-9ae9-4356-80e8-69bc5f749bd1/rtc/connections/7 \
  -H "Authorization: Bearer ak_live_…"

Response · 204

Empty body.

Mint a room-scoped client token

Requires tokens:mint. Mints a signed token for one principal in one room of the key's tenant; the caller cannot choose the tenant. role defaults to the member's stored role and cannot be above it, and ttl_seconds defaults to 600, clamped to 60–3600. device_id is carried in the token so each of a principal's devices gets its own call leg. The bundle also holds the chat and RTC WebSocket URLs and ICE servers with TURN credentials. A room whose status is closed is refused with 409. Revoking the key does not invalidate tokens it already minted; removing the member does.

createSessionToken · scope tokens:mint captured live

Request

curl -X POST https://api.ollacore.com/v1/server/session-tokens \
  -H "Authorization: Bearer ak_live_…" \
  -H "Content-Type: application/json" \
  -d '{"room_id":"25964f12-9ae9-4356-80e8-69bc5f749bd1","principal_id":"alice","role":"owner","ttl_seconds":3600,"device_id":"dev-alice"}'

{
  "room_id": "25964f12-9ae9-4356-80e8-69bc5f749bd1",
  "principal_id": "alice",
  "role": "owner",
  "ttl_seconds": 3600,
  "device_id": "dev-alice"
}

Request fields

Response · 200

{
  "access_token": "eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCIsImtpZCI6ImEwM2I1NjQ4MjM3YjlmZWIifQ.eyJpc3MiOiJjaGF0Ym94LWJhY2tlbmQiLCJhdWQiOiJjaGF0Ym94LXJlYWx0aW1lIiwic3ViIjoiYWxpY2UiLCJ0aWQiOiJhY2N0X2ZhYzkxYjI4MjE5MWNjMDJkZDI5OTEyYzhkYjQzZjFjIiwicmlkIjoiMjU5NjRmMTItOWFlOS00MzU2LTgwZTgtNjliYzVmNzQ5YmQxIiwicm9sZSI6Im93bmVyIiwicGVybWlzc2lvbnMiOlsiY2hhdDpzZW5kIiwiY2hhdDpoaXN0b3J5IiwiYXR0YWNobWVudDp1cGxvYWQiLCJhdHRhY2htZW50OmRvd25sb2FkIiwicnRjOnB1Ymxpc2giLCJydGM6c3Vic2NyaWJlIl0sImRpZCI6ImRldi1hbGljZSIsImp0aSI6ImU5MDg1MDAyLTFkMTAtNGE4My1hZGQyLTcxZmIyM2UxODIwMCIsImlhdCI6MTc5MjMyNDY2NywibmJmIjoxNzkyMzI0NjY3LCJleHAiOjE3OTIzMjgyNjd9.SIGNATURE_REMOVED",
  "expires_at": "2026-01-15T10:30:04Z",
  "rtc_websocket_url": "wss://api.ollacore.com/v1/rtc/ws",
  "chat_websocket_url": "wss://api.ollacore.com/v1/chat/ws",
  "ice_servers": [
    {
      "urls": [
        "stun:api.ollacore.com:3478"
      ]
    },
    {
      "urls": [
        "turn:api.ollacore.com:3478",
        "turns:api.ollacore.com:5349"
      ],
      "username": "1789064267:alice",
      "credential": "EXAMPLE_TURN_CREDENTIAL="
    }
  ]
}

Register a principal (bot/service identity)

Requires members:write. Records principal_id (1–128 characters) in the key's tenant as a non-human sender of kind agent, bot, service or system. Registering it again replaces the kind. Registration is what allows POST /v1/server/rooms/{room_id}/messages to send as this principal, and those messages carry its sender_kind; messages the principal sends with a session token do not. Registering does not add the principal to any room.

registerPrincipal captured live

Request

curl -X POST https://api.ollacore.com/v1/server/principals \
  -H "Authorization: Bearer ak_live_…" \
  -H "Content-Type: application/json" \
  -d '{"principal_id":"support-bot","kind":"agent"}'

{
  "principal_id": "support-bot",
  "kind": "agent"
}

Request fields

Response · 200

{
  "principal_id": "support-bot",
  "kind": "agent"
}

GDPR erase a principal

Async: hard-deletes the principal's messages, memberships, uploaded attachment blobs, receipts, reactions, push subscriptions and E2EE key material; for a directory user, also their profile, OTP challenges and sessions. Every stored copy of their events goes too: the webhook delivery log and any fan-out or push work not yet done. Requires scope data:erase.

erasePrincipal · scope data:erase captured live

Request

curl -X POST https://api.ollacore.com/v1/server/principals/erasable-1/erase \
  -H "Authorization: Bearer ak_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Response · 200

{
  "erasing": true
}

Send as a principal (server-side)

Requires messages:write. The sender must be registered with POST /v1/server/principals and be an active member of the room; any other principal, including any human, is refused with 403. The message carries sender_kind and goes through the same path as a client send: it is persisted, then published as message.created to the room's sockets, webhooks and push. It is idempotent per room and sender on client_message_id (1–128 characters): a repeat returns the original message and does not count against the quota again. kind is one of text, image, voice, video, story, file or system, with a body of at most 16 KiB. An e2ee room accepts only mls.* kinds, up to 128 KiB, and anything else is refused with 409. A message has at most 10 attachments, each already ready in this room, and at most 50 mentions, all active members. With forward_of, the server copies the source message's kind, body and media; the sender must be a member of the source room, and the destination must not be e2ee.

sendMessage · scope messages:write captured live

Request

curl -X POST https://api.ollacore.com/v1/server/rooms/25964f12-9ae9-4356-80e8-69bc5f749bd1/messages \
  -H "Authorization: Bearer ak_live_…" \
  -H "Content-Type: application/json" \
  -d '{"sender_principal_id":"support-bot","client_message_id":"srv-8c1f2a","kind":"text","body":{"text":"Your order #7781 has shipped."}}'

{
  "sender_principal_id": "support-bot",
  "client_message_id": "srv-8c1f2a",
  "kind": "text",
  "body": {
    "text": "Your order #7781 has shipped."
  }
}

Request fields

Response · 200

{
  "id": "e0b25ea0-1320-4862-af8d-bc28a2547b27",
  "event_seq": 5200,
  "room_id": "25964f12-9ae9-4356-80e8-69bc5f749bd1",
  "sender_id": "support-bot",
  "sender_kind": "agent",
  "client_message_id": "srv-8c1f2a",
  "kind": "text",
  "body": {
    "text": "Your order #7781 has shipped."
  },
  "created_at": "2026-01-15T09:30:04Z"
}

Metered usage for a window

Requires usage:read. Sums the tenant's metered events over [from, to), which defaults to the 30 days ending now. The metrics are message.sent, one per new message (an idempotent repeat is not counted), and attachment.bytes, counted once an attachment is verified ready (failed uploads are not counted). A metric with no events in the window is left out. A test key sees only its sandbox's usage.

getUsage · scope usage:read captured live

Request

curl -X GET https://api.ollacore.com/v1/server/usage \
  -H "Authorization: Bearer ak_live_…"

Response · 200

{
  "from": "2025-12-16T09:30:48Z",
  "to": "2026-01-15T09:30:48Z",
  "usage": [
    {
      "metric": "attachment.bytes",
      "total": 160
    },
    {
      "metric": "message.sent",
      "total": 6
    }
  ]
}

Create an endpoint subscription

Requires webhooks:manage. url must be https, and its host must resolve within 3 seconds to public addresses only. Private, loopback, link-local and similar ranges are refused with 400, and the same check runs again on every delivery. event_types must name at least one supported type. A tenant can have at most 10 enabled endpoints, and creating one beyond that is refused with 409. The response returns the HMAC signing secret only this once; store it to verify X-Ollacore-Signature. An endpoint cannot be edited: to change one, create a new endpoint and delete the old one.

createWebhook · scope webhooks:manage captured live

Request

curl -X POST https://api.ollacore.com/v1/server/webhooks \
  -H "Authorization: Bearer ak_live_…" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://hooks.example.com/health","event_types":["message.created","call.started","member.added"]}'

{
  "url": "https://hooks.example.com/health",
  "event_types": [
    "message.created",
    "call.started",
    "member.added"
  ]
}

Request fields

Response · 200

{
  "id": "whe_2416dc932158009799ae0c3d084c29c0",
  "url": "https://hooks.example.com/health",
  "event_types": [
    "message.created",
    "call.started",
    "member.added"
  ],
  "secret": "whsec_EXAMPLE_NOT_A_REAL_SECRET"
}

List endpoints

Requires webhooks:manage. Returns every endpoint of the key's tenant, newest first. Disabled endpoints are included with enabled: false, whether they were disabled by DELETE or automatically after five consecutive failed deliveries. The signing secret is never returned.

listWebhooks · scope webhooks:manage captured live

Request

curl -X GET https://api.ollacore.com/v1/server/webhooks \
  -H "Authorization: Bearer ak_live_…"

Response · 200

[
  {
    "id": "whe_2416dc932158009799ae0c3d084c29c0",
    "url": "https://hooks.example.com/health",
    "event_types": [
      "message.created",
      "call.started",
      "member.added"
    ],
    "enabled": true,
    "created_at": "2026-01-15T09:30:05Z"
  }
]

Delete an endpoint

Requires webhooks:manage. Sets enabled: false on the endpoint. The endpoint and its delivery history stay listed, and it stops counting toward the 10-endpoint limit. Deliveries that are still pending or waiting for a retry are cancelled instead of sent, and a replay to the endpoint is refused with 409. A disabled endpoint cannot be enabled again; 404 if the id is unknown or the endpoint is already disabled.

deleteWebhook · scope webhooks:manage captured live

Request

curl -X DELETE https://api.ollacore.com/v1/server/webhooks/whe_1fa8822227884c369fa023017fd75a2f \
  -H "Authorization: Bearer ak_live_…"

Response · 200

{
  "disabled": true
}

Delivery audit log

Newest first. A delivery is kept until 30 days after it settles (delivered, failed or cancelled), then deleted; one still pending or retrying is kept until it settles. Erasing a room, a principal or the tenant deletes the deliveries of the events erased, and scheduled retention deletes those of the messages it expires.

listWebhookDeliveries · scope webhooks:manage captured live

Request

curl -X GET https://api.ollacore.com/v1/server/webhooks/whe_2416dc932158009799ae0c3d084c29c0/deliveries \
  -H "Authorization: Bearer ak_live_…"

Response · 200

[
  {
    "id": "whd_7d282f27fea842a9ab25a16bc1b2b72a",
    "event_id": "evt_16dac5b07cf72653ebcc599c",
    "event_type": "call.started",
    "status": "delivered",
    "attempt": 0,
    "last_status_code": 200,
    "last_error": null,
    "created_at": "2026-01-15T09:30:33Z",
    "updated_at": "2026-01-15T09:30:34Z"
  },
  {
    "id": "whd_7eebb7ce833d4b1f8f0d05eb10f7e035",
    "event_id": "evt_4656e090af7f80263ee36867",
    "event_type": "message.created",
    "status": "delivered",
    "attempt": 0,
    "last_status_code": 200,
    "last_error": null,
    "created_at": "2026-01-15T09:30:14Z",
    "updated_at": "2026-01-15T09:30:15Z"
  },
  {
    "id": "whd_91cf0dc2f85f4ec1a4a9718d04c5785d",
    "event_id": "evt_113ded9a5ab832955cab6c67",
    "event_type": "message.created",
    "status": "delivered",
    "attempt": 0,
    "last_status_code": 200,
    "last_error": null,
    "created_at": "2026-01-15T09:30:08Z",
    "updated_at": "2026-01-15T09:30:08Z"
  },
  {
    "id": "whd_e7dff7fae5034b78bdc3287f48a5589d",
    "event_id": "evt_1a16ba018c483822d15a987b",
    "event_type": "message.created",
    "status": "delivered",
    "attempt": 0,
    "last_status_code": 200,
    "last_error": null,
    "created_at": "2026-01-15T09:30:07Z",
    "updated_at": "2026-01-15T09:30:08Z"
  },
  {
    "id": "whd_2a6d536f8bd34ae6b1a0995159d87565",
    "event_id": "evt_2f695376505edc586f7fffd9",
    "event_type": "message.created",
    "status": "delivered",
    "attempt": 0,
    "last_status_code": 200,
    "last_error": null,
    "created_at": "2026-01-15T09:30:06Z",
    "updated_at": "2026-01-15T09:30:07Z"
  }
]

Replay a delivery

Re-sends a stored delivery to its endpoint, with the same event id. Possible until 30 days after the delivery settled; after that, or once an erasure or retention removed it, the delivery no longer exists and this returns 404.

replayWebhookDelivery · scope webhooks:manage captured live

Request

curl -X POST https://api.ollacore.com/v1/server/webhooks/whe_2416dc932158009799ae0c3d084c29c0/deliveries/whd_7d282f27fea842a9ab25a16bc1b2b72a/replay \
  -H "Authorization: Bearer ak_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Response · 200

{
  "replayed": true
}