FlowStep: External Data

SendPro allows you to perform an HTTP(s) request to an outside source to retrieve structured data. Any retrieved data is then available for use anywhere in your messages and FlowSteps . You can also use variables in the URL and additional header fields. We currently support JSON or XML formatted data, which we also try to auto-detect which one to use by looking at the Content-Type response header. Basically this means you can fetch and use any RSS feed, simple REST API or XML export to enrich your messages.

Timeline_External data.png

Settings

Settings_External data.png

  • URL (dynamic): Fill in the url where the data should be retrieved from by SendPro
  • Result variable name: Use this variable or specify a variable name that you will use in your template for loading data.
  • Format: Choose the format you want to read.

Advanced

Settings_External data.png

  • Full response in result variable: When you check this option, you will get an object with a StatusCode. Otherwise, you simply get the body.
  • Request method: Choose the method you want to use.
    Request method.png
  • Header name: At which header name can the flow be started? 
  • Header value (dynamic): Fill in the field with a value.
  • Request body (dynamic): This is the code for the request you make to the receiving API.
  • Ignore errors: If you want to continue the flow, even with errors, check this box.
  • Set condition for this FlowStep: Do you want to set a condition? Then a new input field will appear. This allows you to set a condition so that a FlowStep is only executed when it meets a special condition. You write a condition in the Freemarker language (https://freemarker.apache.org/).
  • Comments: Here you can optionally add a comment, so that your colleagues can see why this Flowstep is being performed.