Skip to main content

TriggerPayload

@prismatic-io/spectral"types/TriggerPayload"TriggerPayload

Represents a Trigger Payload, which is data passed into a Trigger to invoke an Integration execution.

Hierarchy#

  • TriggerPayload

Index#

Properties#

Properties#

body#

body: object

Defined in packages/spectral/src/types/TriggerPayload.ts:13

Type declaration:#

  • contentType? : undefined | string

  • data: unknown


customer#

customer: object

Defined in packages/spectral/src/types/TriggerPayload.ts:30

Type declaration:#

  • externalId: string | null

  • id: string | null

  • name: string | null


executionId#

executionId: string

Defined in packages/spectral/src/types/TriggerPayload.ts:29


headers#

headers: object

Defined in packages/spectral/src/types/TriggerPayload.ts:3

Type declaration:#

  • [ key: string]: string

instance#

instance: object

Defined in packages/spectral/src/types/TriggerPayload.ts:35

Type declaration:#

  • id: string | null

  • name: string | null


invokeUrl#

invokeUrl: string

Defined in packages/spectral/src/types/TriggerPayload.ts:28

The URL that was used to invoke the execution.


pathFragment#

pathFragment: string

Defined in packages/spectral/src/types/TriggerPayload.ts:18

Extended path information from the webhook trigger


queryParameters#

queryParameters: object

Defined in packages/spectral/src/types/TriggerPayload.ts:6

Type declaration:#

  • [ key: string]: string

rawBody#

rawBody: object

Defined in packages/spectral/src/types/TriggerPayload.ts:9

Type declaration:#

  • contentType? : undefined | string

  • data: unknown


webhookApiKeys#

webhookApiKeys: object

Defined in packages/spectral/src/types/TriggerPayload.ts:24

The optional API keys assigned to the flows of this integration. These may be unique per integration instance and per flow.

Type declaration:#

  • [ key: string]: string[]

webhookUrls#

webhookUrls: object

Defined in packages/spectral/src/types/TriggerPayload.ts:20

The webhook URLs assigned to this integration's flows upon instance deploy

Type declaration:#

  • [ key: string]: string