Execute an integration (blend) in an account

POST /accounts/{account_externalid_or_guid}/blends/{blend_name_or_guid}/run

Executes an integration (Blend) in a customer account. This creates a run (job) of the integration. Note that you can reference the Blend by its guid, or by its name. This makes it possible to find Blends in multiple accounts, by using unique pre-defined names for Blends.

Note that integrations can also be executed in other ways: blends can be scheduled, they can be triggered through a webhook, or they can be executed manually from the Blendr.io Admin backend.

Use async=false (default) to execute the Blend synchronously, which means the API call will wait for the Blend to finish, and the Blend response will be the response of the API call. When async=true, the API call will create the job but will not wait for the Blend to finish, so the Blend response will not be available. The async parameter can be added in the querystring or in the POST body (see example below).

If the Blend has input parameters, add them in the POST body. Example POST body:

{
  "async": true,
  "inputs": { 
    "inputname1": "value1",
    "inputname2": "value2"
  }
}

Query Parameters

Name Description Type
async Optional, default is false. Set to true to execute the Blend asynchronously. Can be in querystring or in post body. boolean

Path Parameters

Name Description Type
account_externalid_or_guid External id or guid of the customer account string
blend_name_or_guid Name or guid of the Blend to be executed inside the given customer account string

Body Parameters

Name Description Type
Inputs Input parameters json

Examples

{
  "async": true,
  "inputs": { 
    "input_param1": "some value",
    "input_param2": "some value"
  }
}

Results

200

{}

400

{}