Interface ProviderEventContext

What reached the product's events route: the provider authenticates and parses it.

interface ProviderEventContext {
    providerName: string;
    method: string;
    url: string;
    headers: Record<string, undefined | string | string[]>;
    body: string | Buffer<ArrayBufferLike>;
    runId?: string;
}

Properties

providerName method url headers body runId?

Properties

providerName

providerName: string

The provider the route names.

method

method: string

The request's HTTP method.

url

url: string

The request's URL.

headers

headers: Record<string, undefined | string | string[]>

The request's headers.

body

body: string | Buffer<ArrayBufferLike>

The request's body as it arrived, before any parse.

Optional runId

runId?: string

The run the report names, when the route can read it before parsing (a path parameter).

Settings

Member Visibility

Theme

On This Page

providerNamemethodurlheadersbodyrunId