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

Type declaration:​

  • contentType? : undefined | string

  • data: unknown

customer​

• customer: CustomerAttributes

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

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

executionId​

• executionId: string

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

flow​

• flow: FlowAttributes

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

Contains attributes of the Flow that is being executed.

headers​

• headers: object

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

Type declaration:​

  • [ key: string]: string

instance​

• instance: InstanceAttributes

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

Contains attributes of the Instance that is being executed.

integration​

• integration: IntegrationAttributes

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

Contains attributes of the Integration that is being executed.

invokeUrl​

• invokeUrl: string

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

The URL that was used to invoke the execution.

pathFragment​

• pathFragment: string

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

Extended path information from the webhook trigger

queryParameters​

• queryParameters: object

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

Type declaration:​

  • [ key: string]: string

rawBody​

• rawBody: object

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

Type declaration:​

  • contentType? : undefined | string

  • data: unknown

startedAt​

• startedAt: string

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

The time in UTC that execution started.

user​

• user: UserAttributes

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

Contains attributes of the User for whom a User Level Configuration is being used.

webhookApiKeys​

• webhookApiKeys: object

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

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

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

Type declaration:​

  • [ key: string]: string