Pipedream Deploy a Trigger

arazzo: 1.0.1
info:
  title: Pipedream Deploy a Trigger
  summary: Find a trigger for an app, deploy it for an external user, and confirm deployment.
  description: >-
    An event-source provisioning flow for Pipedream Connect. The workflow
    searches the registry for trigger components belonging to an app, retrieves
    the chosen trigger to confirm its configurable props, deploys it for the
    external user, and then lists the user's deployed triggers to confirm the
    new source is live. Every step spells out its request inline so the flow can
    be read and executed without opening the underlying OpenAPI description.
  version: 1.0.0
sourceDescriptions:
- name: deployedTriggersApi
  url: ../openapi/pipedream-deployed-triggers-api-openapi.yml
  type: openapi
- name: triggersApi
  url: ../openapi/pipedream-triggers-api-openapi.yml
  type: openapi
workflows:
- workflowId: deploy-trigger
  summary: List, inspect, deploy, and verify a Connect trigger for an external user.
  description: >-
    Lists triggers for the target app, retrieves the selected trigger component,
    deploys it for the external user with the supplied configured props, and
    confirms the deployment by listing the user's deployed triggers.
  inputs:
    type: object
    required:
    - projectId
    - environment
    - externalUserId
    - app
    - componentId
    properties:
      projectId:
        type: string
        description: The project ID, which starts with proj_.
      environment:
        type: string
        description: The Connect environment (development or production).
      externalUserId:
        type: string
        description: Your end user identifier for whom the trigger is deployed.
      app:
        type: string
        description: The ID or name slug of the app to filter triggers by.
      componentId:
        type: string
        description: The key of the trigger component to deploy.
      configuredProps:
        type: object
        description: The configured props payload required by the trigger.
      webhookUrl:
        type: string
        description: Optional webhook URL to receive the trigger's emitted events.
  steps:
  - stepId: listAppTriggers
    description: >-
      Search the registry for triggers belonging to the target app so the caller
      can confirm the chosen trigger key exists.
    operationId: listTriggers
    parameters:
    - name: project_id
      in: path
      value: $inputs.projectId
    - name: x-pd-environment
      in: header
      value: $inputs.environment
    - name: app
      in: query
      value: $inputs.app
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      triggers: $response.body#/data
      firstTriggerKey: $response.body#/data/0/key
  - stepId: retrieveTrigger
    description: >-
      Retrieve the selected trigger component to confirm its configurable props
      before deploying it.
    operationId: retrieveTrigger
    parameters:
    - name: project_id
      in: path
      value: $inputs.projectId
    - name: x-pd-environment
      in: header
      value: $inputs.environment
    - name: component_id
      in: path
      value: $inputs.componentId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      triggerName: $response.body#/data/name
      configurableProps: $response.body#/data/configurable_props
  - stepId: deployTrigger
    description: >-
      Deploy the trigger for the external user with the supplied configured
      props and optional webhook destination.
    operationId: deployTrigger
    parameters:
    - name: project_id
      in: path
      value: $inputs.projectId
    - name: x-pd-environment
      in: header
      value: $inputs.environment
    requestBody:
      contentType: application/json
      payload:
        id: $inputs.componentId
        external_user_id: $inputs.externalUserId
        configured_props: $inputs.configuredProps
        webhook_url: $inputs.webhookUrl
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      deployedTriggerId: $response.body#/data/id
  - stepId: verifyDeployedTrigger
    description: >-
      List the external user's deployed triggers to confirm the freshly deployed
      source is present.
    operationId: listDeployedTriggers
    parameters:
    - name: project_id
      in: path
      value: $inputs.projectId
    - name: x-pd-environment
      in: header
      value: $inputs.environment
    - name: external_user_id
      in: query
      value: $inputs.externalUserId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      deployedTriggers: $response.body#/data
  outputs:
    deployedTriggerId: $steps.deployTrigger.outputs.deployedTriggerId
    deployedTriggers: $steps.verifyDeployedTrigger.outputs.deployedTriggers