Managing Trigger Keys

Trigger keys allow for a pipeline to be triggered through an API call. This will allow the pipeline to be triggered remotely from a local machine or to integrate into a CI/CD pipeline.

To get there:

  1. Select the Pipelines section from the main, left-hand navigation.
  2. Select the pipeline from the first column.
  3. Click Trigger Keys from the horizontal navigation on the pipeline dashboard.
trigger keys navigation

Create a Trigger Key

  1. In the Create Trigger Key form, enter a name and any IP restrictions
  2. Press and hold the Create Key button.
  3. The trigger key modal will open where the trigger key secret will appear. This will ONLY be shown once, so copy from this modal and store somewhere safe.
  4. Copy the curl request from the Post Info panel to remotely trigger the pipeline.
create trigger key

Key Obfuscation

After creating the trigger key, the modal will open and the key will be available to be copied one time. Once this page is refreshed or navigation happens the key will be obfuscated on subsequent views and cannot be seen again.

Updating a Trigger Key

Clicking on an individual trigger key will open a modal where the user can update the name or IP restrictions associated with the key.

trigger key modal