Interface: SDKExecutionPayload

interfaces.SDKExecutionPayload

The payload for creating an execution.

Interface

SDKExecutionPayload

Table of contents

Properties

• sync
• caption
• functionName
• input
• notification
• projectId
• serviceName
• successMessage
• title

Properties

sync

• Optional sync: boolean

Enabled by default, this feature ensures that the platform subscribes to changes and monitors the execution's status, consequently triggering events for execution status updates.

To track these changes from an application, you can subscribe to the DlEvent.EXECUTION_STATUS event.

await dl.on(DlEvent.EXECUTION_STATUS, (payload: { execution: SDKExecution, status: 'created' | 'success' | 'failed' }) => {
    console.log(`Execution ${payload.execution.id} status: ${payload.status}`)
    console.log(`Execution output`, payload.execution.output)
})

caption

• Optional caption: string

The notification caption

functionName

• functionName: string

The name of the function

input

• input: Dictionary

The function's inputs as a dictionary

notification

• Optional notification: boolean

Add a notification to the execution

projectId

• Optional projectId: string

The project id

serviceName

• serviceName: string

The name of the service

successMessage

• Optional successMessage: string

A success toast message string

title

• Optional title: string

The notification's title