Events API reference

Ticket events of every channel: one signed webhook per bucket and live WebSocket subscriptions.

Requests go to https://api.revdoku.com. Every path starts with /v1, for example https://api.revdoku.com/v1/buckets. Send Authorization: Bearer $REVDOKU_API_KEY from your server. Tables use JSON names; where TypeScript differs, a field shows json_name / typescriptName. Python uses the JSON names.

All operations · API guide · Errors · OpenAPI

• Read the webhook: GET /v1/buckets/{bucket_id}/webhook
• Set the webhook: PUT /v1/buckets/{bucket_id}/webhook
• Remove the webhook: DELETE /v1/buckets/{bucket_id}/webhook
• Get a live event subscription ticket: GET /v1/buckets/{bucket_id}/events/subscription

Read the webhook

GET /v1/buckets/{bucket_id}/webhook

Requires bucket-admin permission.

webhook is null when no webhook is set. The signing secret is never returned here.

Parameters

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.getWebhook({ bucketId: 'bkt_example' });
console.log(data);

Python

from revdoku import Revdoku

client = Revdoku()
response = client.api.get_webhook("bkt_example")
print(response.data)

cURL

curl "https://api.revdoku.com/v1/buckets/bkt_example/webhook" \
  -H "Authorization: Bearer $REVDOKU_API_KEY"

Response 200

Errors

Guide: Webhooks and live subscriptions

Set the webhook

PUT /v1/buckets/{bucket_id}/webhook

Requires bucket-admin permission and a public HTTPS URL.

The webhook receives the bucket’s ticket events (TicketEvent): ticket.created and ticket.message_received, for every channel. A new URL or rotate_secret=true creates a new signing secret, returns it once and cancels pending deliveries. The same URL without rotate_secret returns the webhook without a secret.

Parameters

Request body: TypeScript setWebhookRequest: SetWebhookRequest, Python set_webhook_request=SetWebhookRequest(...).

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.setWebhook({
  bucketId: 'bkt_example',
  setWebhookRequest: { webhookUrl: 'https://example.com/revdoku/webhook' },
});
console.log(data);

Python

from revdoku import Revdoku, SetWebhookRequest

client = Revdoku()
response = client.api.set_webhook(
    "bkt_example",
    SetWebhookRequest(webhook_url="https://example.com/revdoku/webhook"),
)
print(response.data)

cURL

curl -X PUT "https://api.revdoku.com/v1/buckets/bkt_example/webhook" \
  -H "Authorization: Bearer $REVDOKU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"webhook_url": "https://example.com/revdoku/webhook"}'

Response 200

Errors

Guide: Webhooks and live subscriptions

Remove the webhook

DELETE /v1/buckets/{bucket_id}/webhook

Cancels queued deliveries. A delivery already in progress can finish. Returns the bucket ID, also when no webhook is set.

Parameters

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.deleteWebhook({ bucketId: 'bkt_example' });
console.log(data);

Python

from revdoku import Revdoku

client = Revdoku()
response = client.api.delete_webhook("bkt_example")
print(response.data)

cURL

curl -X DELETE "https://api.revdoku.com/v1/buckets/bkt_example/webhook" \
  -H "Authorization: Bearer $REVDOKU_API_KEY"

Response 200

Errors

Guide: Webhooks and live subscriptions

Get a live event subscription ticket

GET /v1/buckets/{bucket_id}/events/subscription

Requires bucket read permission.

Connect to websocket_url with subscription_token=TOKEN within 60 seconds, then subscribe to BucketEventsChannel with account_id and bucket_id. Each event is a TicketEvent. Catch up with GET /v1/buckets/{bucket_id}/tickets and updated_after after every connect.

Parameters

Examples

TypeScript

import { Revdoku } from 'revdoku';

const client = new Revdoku();
const { data } = await client.api.getEventSubscription({
  bucketId: 'bkt_example',
});
console.log(data);

Python

from revdoku import Revdoku

client = Revdoku()
response = client.api.get_event_subscription("bkt_example")
print(response.data)

cURL

curl "https://api.revdoku.com/v1/buckets/bkt_example/events/subscription" \
  -H "Authorization: Bearer $REVDOKU_API_KEY"

Response 200

Errors

Guide: Webhooks and live subscriptions