Interface: SDKExecutionPayload
sdkApi/interfaces/entities/iExecution.SDKExecutionPayload
The payload for creating an execution
Interface
SDKExecutionPayload
Table of contents
Properties
- caption
- functionName
- input
- notification
- onFailureEvent
- onSuccessEvent
- projectId
- serviceName
- successMessage
- sync
- title
Properties
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
onFailureEvent
• Optional
onFailureEvent: EventPayload
An event to be triggered on execution failure
onSuccessEvent
• Optional
onSuccessEvent: EventPayload
An event to be triggered on execution success
projectId
• Optional
projectId: string
The project id
serviceName
• serviceName: string
The name of the service
successMessage
• Optional
successMessage: string
A success toast message string
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.
title
• Optional
title: string
The notification title