Skip to main content
One method per route Tappify calls, plus raw for the response itself.

Methods

action()

Calls one action by id.

Parameters

id
string
input
unknown

Returns

Promise<unknown>

context()

Calls one context block by id.

Parameters

id
string

Returns

Promise<ContextBlock>

event()

Posts one Tappify event, which the handler answers with 204.

Parameters

name
string
payload
Record<string, unknown>

Returns

Promise<void>

health()

Calls the health route, which carries no token.

Returns

Promise<TappifyHealth>

mention()

Calls one mention by id, with the query as the q parameter.

Parameters

id
string
query
string

Returns

Promise<MentionItems>

metrics()

Calls the connector’s metrics route.

Parameters

input
MetricsInput

Returns

Promise<MetricsResponse>

procedure()

Calls one procedure by name; the input defaults to an empty object.

Parameters

name
string
input?
unknown

Returns

Promise<unknown>

raw()

Sends any method and path and returns the Response, for a test that asserts on a status rather than a body.

Parameters

method
string
path
string
body?
unknown

Returns

Promise<Response>

tool()

Calls one tool by id and returns the card it answered with.

Parameters

id
string
input
unknown

Returns

Promise<unknown>

work()

Calls one work operation.

Parameters

operation
WorkOperation
input
unknown

Returns

Promise<unknown>