Skip to content
Branch: master
Find file History
Latest commit 800dd00 Sep 26, 2019
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
creating-first-workflow.png fix case Jun 26, 2019
emailtosubject.png fix case Jun 26, 2019
optionalemail.png fix case Jun 26, 2019
postman.png fix case Jun 26, 2019
readme.md Update readme.md Sep 26, 2019
sendemail.png fix case Jun 26, 2019
sendemailrightdialog.png fix case Jun 26, 2019
straightemail.png fix case Jun 26, 2019
testemail.png fix case Jun 26, 2019
testinitialemail.png fix case Jun 26, 2019
trigger.png fix case Jun 26, 2019
webhook.jpg Add first example May 10, 2019
webhookconfigured.png fix case Jun 26, 2019

readme.md

Hello Email

This examples guides you on a simple webmethods hello world that uses no external SaaS services, but does assume you have access to an email client. The guide shows how to setup an rest api endpoint in webmethodsio (webhook) and output an email when the api is accessed, which can be easily accomplished with a simple GET request from Curl, Postman or even your internet browser.

Setup

  1. Go ahead and get started creating a blank workflow. If you need a refresher on how to get to this point, this guide can be a great introduction. Your starting point should resemble this

  2. The Webhook is created by modifying the start icon, which is is the entrypoint to the new flow. Please select the gear on top of the start icon to access settings. Once settings is selected in the start icon, a 'trigger' dialog will appear that allows Webhook to be selected.trigger

  3. Leave Webhook Authentication and Webhook Payload unchecked for now and hit next. Feel free to modify these if desired, they are easy to return to and iterate as well. At the very least, Authentication should be added immedately after 'Hello world' is working. Note the webhook url and save this for later. webhook

(Optional) You can curl the webhook url at this point as a type of preliminary test. The url will state that it exists but will return an error message as the entire flow has not been completed and saved yet. Alternatively, you can put the url in your internet browser for quick feedback if you prefer.

curl https://<cloudname>.int-aws-us.webmethods.io/runflow/run/xxxxxxx 

which will return this if the url is correct.

{"error":"Parameters missing. Please provide all required parameters in actions before running workflow","code":126}

And if the url is incorrect, you will receive:

{"message":"Workflow not found.","code":103}
  1. Select done once presented with the final dialog. You should now see the start arrow dialog replaced with a webhook icon. webhookconfigured

  2. Now lets have the flow do something once the webhook receives a request. Search in the search dialog for 'email' and find the 'Send an Email' notification. sendemailrightdialog

  3. Select the 'Send an Email' and drag it between the start and end icons. Connect the arrows from start to the email icon and then to the end icon. This inserts the 'Send an Email' step in the flow. (optional) If you are obsessive compulsive like me, spend an extra five minutes making sure the arrow lines between start, email and end are completely straight. straightemail

  4. Next, select the gear icon at the top of the email icon. You should land in a dialog that enables you to name the email step. Change the name if you like (or leave it the same) and select Next. sendemail

  5. Initially, you can fill in the 'To', 'Subject' and 'Body' required fills with any text you like. emailtosubject (Optional) Fill the subject and body with information from the webhook to create a more interesting demo email. optionalemail

  6. Select next and then you will be provided with a dialog that allows an overview of the email payload and the capability to test the connect. Go ahead and hit test, wait a minute and see if the email arrives in your inbox. If everything is satisfactory go ahead and select 'Done'. testinitialemail

  7. Assuming the steps so far are satisfactory, go ahead and select 'Test' in the top right to trigger a test of the entire workflow. This should deliver a dummy email to you inbox. Once this happens go ahead and press 'Save' to save and enable the workflow. testemail

  8. Test workflow

Curl command example

curl https://<cloudname>.int-aws-us.webmethods.io/runflow/run/xxxxxxx 

If all goes well, you will see something similiar

{"message":"Workflow enqueued successfully.","code":123,"bill_uid":"123123123123123","flow_uid":"1231231234","tenant_uid":"123123123"}

Postman example

Just put your url into the 'Get' dialog box and hit send. If all goes well you will see a 'Workflow enqueud successfully' response and receive an email shortly after.

postman

Internet browser example

Copy and paste the Web Methods trigger url, for example (https://.int-aws-us.webmethods.io/runflow/run/xxxxxxx), into your favorite internet browser will also work if Curl or Postman are not readily accessible to you.

You can’t perform that action at this time.