IRironcladapp
Adapters

Run an Adapter Flow

Changed on

Runs an adapter flow that has been configured to trigger on-demand via the API. The request body is passed through unchanged as the flow's input.

installId and flowName must each be 1-255 characters long.

OAuth Scope required: public.adapters.triggerFlow

post/adapters/installs/{installId}/flows/{flowName}

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/adapters/installs/{installId}/flows/{flowName}
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.adapters.triggerFlow

Path parameters

installIdstring required

The ID of the adapter install the flow belongs to.

flowNamestring required

The name of the flow to run.

Response

200

state'queued' | 'running' | 'succeeded' | 'failed' | 'partial' required

The overall status of the flow run.

outputobject required

The flow's final output. Shape depends on how the flow is authored.

nodeStatesobject required

Per-step results, keyed by the flow definition's authored step id (not stepName — the same step can be referenced by more than one node).

failedNodeIdstring

The authored step id of the node that failed, if any. A key into nodeStates.

Changes