API Trigger

A workflow can be triggered by making an API call (post request) to the Paradym server with the ID of the workflow that you want to execute. You can add payload to your request to pass data to the workflow. This payload should conform to the input schema as defined in the workflow. You can also use hardcoded values.

Read more about how to execute your workflow through the Paradym API in Executing a workflow.

Example usage:

YAML
name: Send basic message
 
trigger:
  type: api
 
input:
  type: 'object'
  properties:
    invitationUrl:
      type: string
    message:
      type: string
  required:
    - invitationUrl
    - message
 
actions:
  - id: receiveInvitation
    name: didcomm/receiveInvitation@v1
    attributes:
      invitationUrl: $.input.invitationUrl