IRironcladapp
Workflows

Create a Workflow Asynchronously

Changed on

Launch a new Workflow asynchronously for non-blocking performance, which is helpful when/if you provide files to the Workflow.

OAuth Scope required: public.workflows.createWorkflows

post/workflows/async

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/workflows/async
  • 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.workflows.createWorkflows

Query parameters

useDefaultValuesboolean

If values are not specified for a given field, use the default values specified in the launch form configuration.

Headers

x-as-user-emailstring
Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Request body

templatestring required

The identifier of the workflow template

Example request

{
  "template": "600b296c3e15a234ab88f884",
  "attributes": {
    "counterpartyName": "Example Company",
    "draft": [
      {
        "url": "https://www.law.berkeley.edu/wp-content/uploads/2018/12/Resume-Samples-1.pdf"
      }
    ],
    "localLinkedRecord": "IC-123",
    "localParentRecord": "IC-456",
    "localChildRecord": "IC-789"
  }
}

Response

The response of the initiated async workflow launch.

asyncJobIdstring required
asyncJobStatusUrlstring required

Example response

{
  "asyncJobId": "jobIda89474a8ba364f79bb510517d7bd3fea",
  "asyncJobStatusUrl": "https://ironcladapp.com/public/api/v1/workflows/async/jobIda89474a8ba364f79bb510517d7bd3fea"
}

Changes