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:15

Type declaration:#

  • contentType? : undefined | string

  • data: unknown


customer#

customer: Customer

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

Contains attributes of the Customer for whom an Instance is being executed.


executionId#

executionId: string

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


headers#

headers: object

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

Type declaration:#

  • [ key: string]: string

instance#

instance: Instance

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

Contains attributes of the Instance that is being executed.


invokeUrl#

invokeUrl: string

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

The URL that was used to invoke the execution.


pathFragment#

pathFragment: string

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

Extended path information from the webhook trigger


queryParameters#

queryParameters: object

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

Type declaration:#

  • [ key: string]: string

rawBody#

rawBody: object

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

Type declaration:#

  • contentType? : undefined | string

  • data: unknown


webhookApiKeys#

webhookApiKeys: object

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

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:22

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

Type declaration:#

  • [ key: string]: string