Kick off a Boomi Process outside of Boomi

You may find yourself at a point where you have successfully deployed a process in Boomi and now want to trigger it to run from outside. The best way to do this is the Boomi AtomSphere API. The steps described below will show you how to trigger your First Boomi process from Postman.

This article is intended for individuals who have a Boomi Associate Integration Developer Certification. If you do not know how to complete an action like “navigate to the process,” please complete the recommended trainings.

Account Identifiers, used to replace {accountId} in the instructions below:

  • Operations Technology Support: uconnapplicationtechnolog-RQ65GY

  • Campus Technology Services: uconncampustechnologyserv-H3HRGR

  • Finance IT: uconnfinanceit-E9E3XF

  • Identity and Access Management: uconnidentityandaccessman-L63PHP

  • Student Affairs IT: uconnstudentaffairsit-9VEKSZ

  • Student and Human Resources Administration: uconnstudentandhumanresou-P8B8UI

  • Data Management, Reporting and Analytics: uconndatamanagementandrep-QBC9DO

  • Applications and Technology Support: uconnapplicationsandtechn-QBMF1S

 Instructions

Familiarity with a tool like Postman or the basic flow of APIs is necessary to replicate these steps. Follow the instructions below to send a POST to https://api.boomi.com/api/rest/v1/{accountId}/executeProcess

  1. The {accountId} in the POST corresponds to your subaccount listed above.

  2. You need an API token associated with your user account. If you do not have one already, go to the Settings menu and click Account Information and Setup.

  3. Under the My User Settings menu, click AtomSphere API Tokens.

  4. Click + Add New Token. Enter a name and click Generate Token.

  5. Copy and Store the value of your token in a safe place to use later.

  6. Click on the User Information menu and note the email address associated with your account. The username for Basic Authentication will be BOOMI_TOKEN.{thisemailaddress}, or in the case of the user shown here, BOOMI_TOKEN.lara.juenger@uconn.edu.

  7. Navigate to Build and open the process you plan to execute. In the lower right corner click Revision History. Record the Component ID for this process.

  8. Go to Atom Management.

  9. Select the Atom where the process is deployed and where you would like to execute it from and note the Atom ID.

  10. Go to Postman. Best practice suggests you should create a Boomi AtomSphere related environment and set some of the values from above into postmanVariables.

  11. Best practice suggest creating a collection like Boomi AtomSphere APIs shown here. Configure a POST request. Set to Basic Auth and substitute the {{postmanVariables}} as appropriate.

  12. The body of the post is shown below, and you put the Component ID from above as the processId and the Atom ID from above as the atom Id. Click Send.

    <ProcessExecutionRequest processId=" " atomId=" " xmlns="http://api.platform.boomi.com/"> <ProcessProperties> <ProcessProperty> <Name>priority</Name> <Value>medium</Value> </ProcessProperty> </ProcessProperties> </ProcessExecutionRequest>
  13. There is no body in the response, but you will see “200 OK” when the process is executed.

  14. Log in to Process Reporting and verify that the process ran. You can check the logs to confirm the process behaved as designed.

 

 Related articles