TappifyHandlerOptions - Tappify Documentation

The routes and settings createTappifyHandler builds a fetch handler from.

Remarks

The tools, actions and procedures tables are keyed by the names the augmentation tappify extension types writes, so a handler for an undeclared name does not compile. events is keyed by Tappify’s own event catalogue and work by the fixed set of work operations; mentions and context take any id. A route Tappify calls with no handler registered answers 404 with TAP_HANDLER_MISSING. Export this object as well as the handler: the testing entry’s createTestClient takes the options, not the built handler.

Properties

actions?

optional actions?: {
[key: string]: 
  | TappifyRouteHandler<unknown, unknown, unknown>
  | undefined;
};

One handler per declared action, answering POST /tappify/actions/<id>.

Index Signature

[key: string]: 
  | TappifyRouteHandler<unknown, unknown, unknown>
  | undefined

basePath?

optional basePath?: string;

The prefix your framework mounts the handler under, such as /api.

context?

optional context?: Record<string, TappifyRouteHandler<undefined, ContextBlock, unknown>>;

One handler per declared context block, answering GET /tappify/context/<id>.

events?

optional events?: {
  approval.requested?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  digest.sent?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  featuring.started?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  incident.opened?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  incident.resolved?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  install.created?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  install.paused?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  install.resumed?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  install.revoked?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  install.token_rotated?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  keyword.set_changed?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  metadata.changed?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  playbook.step_approved?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  price.changed?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  release.shipped?: TappifyRouteHandler<undefined, void, {
     build: string;
     version: string;
  }>;
  review.thread_opened?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  review.thread_resolved?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  scopes.changed?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  score.changed?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  screenshots.updated?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
  settings.changed?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;
};

One handler per Tappify event you subscribe to; each answers 204.

approval.requested?

optional approval.requested?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

digest.sent?

optional digest.sent?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

featuring.started?

optional featuring.started?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

incident.opened?

optional incident.opened?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

incident.resolved?

optional incident.resolved?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

install.created?

optional install.created?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

install.paused?

optional install.paused?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

install.resumed?

optional install.resumed?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

install.revoked?

optional install.revoked?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

install.token_rotated?

optional install.token_rotated?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

keyword.set_changed?

optional keyword.set_changed?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

metadata.changed?

optional metadata.changed?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

playbook.step_approved?

optional playbook.step_approved?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

price.changed?

optional price.changed?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

release.shipped?

optional release.shipped?: TappifyRouteHandler<undefined, void, {
  build: string;
  version: string;
}>;

review.thread_opened?

optional review.thread_opened?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

review.thread_resolved?

optional review.thread_resolved?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

scopes.changed?

optional scopes.changed?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

score.changed?

optional score.changed?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

screenshots.updated?

optional screenshots.updated?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

settings.changed?

optional settings.changed?: TappifyRouteHandler<undefined, void, Record<string, unknown>>;

extensionId

extensionId: string;

The id from the manifest, which the install token’s audience has to match.

health?

optional health?: () => 
  | TappifyHealth
| Promise<TappifyHealth>;

Answers GET /tappify/health. Left out, the route answers { ok: true }.

Returns

| TappifyHealth | Promise<TappifyHealth>

jwks?

optional jwks?: JSONWebKeySet;

A key set to verify against, which skips the fetch. For tests.

jwksUrl?

optional jwksUrl?: string;

Where to fetch the signing keys. Defaults to DEFAULT_JWKS_URL.

mentions?

optional mentions?: Record<string, TappifyRouteHandler<{
  q: string;
}, MentionItems, unknown>>;

One handler per declared mention, answering GET /tappify/mentions/<id>?q=.

metrics?

optional metrics?: TappifyRouteHandler<MetricsInput, MetricsResponse, unknown>;

Answers POST /tappify/metrics for a connector contribution.

procedures?

optional procedures?: {
[key: string]: 
  | TappifyRouteHandler<unknown, unknown, unknown>
  | undefined;
};

One handler per declared procedure, which is what useTapServer calls.

Index Signature

[key: string]: 
  | TappifyRouteHandler<unknown, unknown, unknown>
  | undefined

tools?

optional tools?: {
[key: string]: 
  | TappifyRouteHandler<unknown, unknown, unknown>
  | undefined;
};

One handler per declared tool, answering POST /tappify/tools/<id>.

Index Signature

[key: string]: 
  | TappifyRouteHandler<unknown, unknown, unknown>
  | undefined

work?

optional work?: {
  attach?: TappifyRouteHandler<Record<string, unknown>, unknown, unknown>;
  comment?: TappifyRouteHandler<Record<string, unknown>, unknown, unknown>;
  create?: TappifyRouteHandler<Record<string, unknown>, unknown, unknown>;
  list_containers?: TappifyRouteHandler<Record<string, unknown>, unknown, unknown>;
  resolve?: TappifyRouteHandler<Record<string, unknown>, unknown, unknown>;
  status?: TappifyRouteHandler<Record<string, unknown>, unknown, unknown>;
};

One handler per work operation, answering POST /tappify/work/<operation>.

attach?

optional attach?: TappifyRouteHandler<Record<string, unknown>, unknown, unknown>;

comment?

optional comment?: TappifyRouteHandler<Record<string, unknown>, unknown, unknown>;

create?

optional create?: TappifyRouteHandler<Record<string, unknown>, unknown, unknown>;

list_containers?

optional list_containers?: TappifyRouteHandler<Record<string, unknown>, unknown, unknown>;

resolve?

optional resolve?: TappifyRouteHandler<Record<string, unknown>, unknown, unknown>;

status?

optional status?: TappifyRouteHandler<Record<string, unknown>, unknown, unknown>;

​Remarks

​Properties

​actions?

​Index Signature

​basePath?

​context?

​events?

approval.requested?

digest.sent?

featuring.started?

incident.opened?

incident.resolved?

install.created?

install.paused?

install.resumed?

install.revoked?

install.token_rotated?

keyword.set_changed?

metadata.changed?

playbook.step_approved?

price.changed?

release.shipped?

review.thread_opened?

review.thread_resolved?

scopes.changed?

score.changed?

screenshots.updated?

settings.changed?

​extensionId

​health?

​Returns

​jwks?

​jwksUrl?

​mentions?

​metrics?

​procedures?

​Index Signature

​tools?

​Index Signature

​work?

​attach?

​comment?

​create?

​list_containers?

​resolve?

​status?

Remarks

Properties

actions?

Index Signature

basePath?

context?

events?

extensionId

health?

Returns

jwks?

jwksUrl?

mentions?

metrics?

procedures?

Index Signature

tools?

Index Signature

work?

attach?

comment?

create?

list_containers?

resolve?

status?