Introduction
Understanding organizationsUnderstanding componentsManage organizationsManage componentsManage component Jira integrations
Set up your first organizationUnderstanding users and teamsUnderstanding role-based access controlManage usersManage teamsConfigure role-based access controlRBAC permissions reference
Understanding authentication in CloudBees UnifySet up multifactor authenticationConfigure SAML single sign-onConfigure OIDC authenticationConfigure network security policiesNetwork security reference
Understanding platform configurationUnderstanding environmentsManage properties and secretsManage environmentsTrack environment inventoryConfigure containersSet up preconfigured actionsConfigure notifications
Accessibility policy referenceShared responsibility model referenceSubscription and services agreementSupport policiesSupported browsers and external tools
Introduction
Understanding feature managementUnderstanding Configuration as CodeGet started with feature managementCreate and manage feature flagsConfigure feature flag targetingOrganize feature flagsImplement feature flag governanceConfiguration as Code reference
Understanding flag impressions and activity statusUnderstanding flag healthUnderstanding code referencesReview and clean up feature flagsSet up code references
Understanding Jira integration for feature flagsSet up the Jira integrationLink Jira tickets to feature flags
Understanding multiple SDK keysBuild your first mobile app with feature flagsBuild your first feature-flagged web applicationBuild your first feature-flagged backend serviceInstall client-side SDKsInstall server-side SDKsConfigure multiple SDK keysMobile SDK referenceWeb SDK referenceBackend SDK referenceClient SDK referenceFlag implementation reference
Introduction
Understanding CI workflowsCreate a build workflowCreate and manage workflowsCreate reusable workflowsTest and validate containers in workflowsCheck out source codeTrigger workflows remotelyWorkflow syntax referenceJobs syntax referenceSteps syntax referenceServices syntax reference
Monitor workflow runsView test results in runsView evidence in runsView deployments in runsManage workflow artifactsPublish test resultsPublish evidence itemsGenerate a software bill of materialsManage ServiceNow change requests
Configure workflow credentialsConfigure AWS credentialsConfigure container registry credentialsConfigure Git credentialsIntegrate external secret providers
Understanding GitHub Actions integrationSet up GitHub Actions integrationDisplay GitHub Actions workflows and runsRegister GHA build artifactsPublish GHA deployed artifactsPublish GHA test resultsPublish GHA evidence itemsTrigger CloudBees workflows from GitHub ActionsScan with GitHub Actions
Understanding CloudBees CI and Jenkins® integrationConnect CI and Jenkins controllersMonitor CI and Jenkins buildsRegister CI build artifactsRegister CI deployed artifactsPublish CI test resultsConfigure CI security scanningCI and Jenkins integration reference
Build and publish container imagesUnderstanding external CI/CD integrationsRun external CI/CD jobsExternal CI/CD action reference
Introduction
Understanding release orchestrationManage applicationsCreate deployer workflowsCreate staged workflowsCreate and manage releasesOrchestrate multi-workflow releasesRelease management reference
Understanding artifact managementRegister and track artifactsStore and retrieve artifactsPromote artifactsGenerate a software bill of materialsArtifact management reference
Deploy with HelmDeploy to KubernetesContainer deployment reference
Deploy to AWSAWS deployment reference
Deploy with enterprise platformsExecute remote deployment commandsEnterprise deployment reference
Verify deployments with New RelicDeployment verification reference

Trigger workflows remotely

2 minute read

Use any API client, such as an external IDE, to trigger a CloudBees Unify workflow run using a curl command. Users with the appropriate permissions can start a workflow without accessing the UI, as long as the workflow contains a workflow_dispatch trigger.

Prerequisites

You must first perform the following tasks to trigger a workflow remotely:

Form the curl command

Configure a curl command to invoke the manually-triggered workflow.

To form the curl command:

  1. Select an organization, and then select the component with the manually-triggered workflow that you want to run remotely.

  2. Locate the component ID and copy it for use in the curl command.

  3. In your component, select a workflow containing a workflow_dispatch trigger from Workflows, and then copy the following for use in the curl command:

    • The workflow branch name.

    • The workflow filename, for example, my-workflow.yaml.

      To be triggered using an API, a workflow must contain a workflow_dispatch trigger.

  4. (Optional) Add input parameters to the trigger as key/value pairs, to customize workflow runtime behavior.

  5. Using the copied information, configure the curl command in the format below:

    curl --location 'https://api.cloudbees.io/v2/components/<COMPONENT_ID>/trigger' \ (1)
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <PERSONAL_ACCESS_TOKEN>' \ (2)
 --data '{
  "branchName": "<REPOSITORY_BRANCH>", (3)
  "workflowFileName": "<WORKFLOW_FILE.YAML>", (4)
  "inputs": { (5)
    "<string_parameter_name>": "<string_value>",
    "<number_parameter_name>": "<number_value>",
    "<boolean_parameter_name>": "<boolean_value>",
    "<choice_parameter_name>": "<choice_option1>,<choice_option2>,<choice_option3>,<default_option>"
  }
}'
    ▼
    1 Replace <COMPONENT_ID> with the CloudBees Unify component ID to form the endpoint URL.
    2 Replace <PERSONAL_ACCESS_TOKEN> with your personal access token.
    3 Replace <REPOSITORY_BRANCH> with the repository branch name.
    4 Replace <WORKFLOW_FILENAME.YAML> with the workflow filename. For example, my-filename.yaml.
    5 Include any applicable parameter names and valid values in the trigger inputs.

The curl command is configured to run your workflow remotely.

Usage example

The following shows an example workflow with manual trigger inputs and the corresponding curl command to invoke it:

Example workflow with manual trigger
apiVersion: automation.cloudbees.io/v1alpha1
kind: workflow
name: Remote workflow
on:
  push:
    branches:
      - "test-branch"
  workflow_dispatch:
    inputs:
      my_string:
        type: string
        default: my value
      my_boolean:
        type: boolean
        default: true
      my_choice:
        type: choice
        options:
          - https://example.com
          - https://example.net
          - https://example.io
        default: https://example.com
jobs:
  build:
    steps:
      - name: Say hello
        uses: docker://golang:1.20.3-alpine3.17
        shell: sh
        run: |
          echo "hello world"
▼
Corresponding curl command
curl --location 'https://api.cloudbees.io/v2/components/abc123-def456-ghi789/trigger' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer your-personal-access-token-here' \
 --data '{
  "branchName": "test-branch",
  "workflowFileName": "remote-workflow.yaml",
  "inputs": {
    "my_string": "custom value",
    "my_boolean": "false",
    "my_choice": "https://example.net"
  }
}'
▼

Trigger the workflow run by executing the curl command in an external tool.

Next steps

Check out source code
Workflow syntax reference