API triggers

API triggers offer a streamlined way of starting a job via HTTP, through a custom request URL created by you. They work as a layer wrapped around existing processes, and leverage the options that are already available for triggers.

Once you create an API trigger, you can easily start a job in an external application and consume its output.

Authentication

API trigger invocations and calls are authorized through personal access tokens.

All you need to do is generate a token that you can use to access the resources you need, and use the token in your requests. For example, if your process requires read and write access to Orchestrator job, you would select the OR.Jobs resource.

Once generated and copied, you can paste it in your bearer token field to authorize job requests.

Permissions

These are the permissions you need to perform operations on API triggers:

• Triggers permission at the folder level (this dictates the actions you can take on API triggers):

  • View - allows you to see API triggers within your tenant.

  • Edit - allows you to make changes to API triggers.

  • Create - allows you to create API triggers.

  • Delete - allows you to delete API triggers.

• Jobs permission at the folder level (this is required to invoke a job trigger and follow the job execution until the result is available):

  • Create - allows you to start an API call based on an API trigger.

  • View - allows you to view the status of the API request.