Register tenant webhook endpoints, manage them, inspect deliveries, and dispatch events. Bearer required.
import { GatekeeperCore, WebhooksService } from '@orkait/sdk';
const webhooks = new WebhooksService(core);Methods#
| Method | Returns | Notes |
|---|---|---|
registerEndpoint(tenantId, url, events, secret?) | WebhookEndpoint | secret returned once if generated |
listEndpoints(tenantId) | Page<WebhookEndpoint> | secret stripped |
updateEndpoint(id, updates) | WebhookEndpoint | { url?, secret?, events?, active? } |
deleteEndpoint(id) | void | |
dispatch(tenantId, eventType, payload) | WebhookDelivery[] | fans out to subscribed endpoints |
deliveries(endpointId, options?) | Page<WebhookDelivery> | delivery history; options: { limit?, cursor? } |
Example#
const ep = await webhooks.registerEndpoint('t1', 'https://hooks.example.com/x', ['user.created']);
await webhooks.dispatch('t1', 'user.created', { id: 'usr_1' });
const log = await webhooks.deliveries(ep.id);