How to Run an Integration from Glyue

Using the Integration Runner

Running an integration in Glyue involves composing a payload that matches the integration's requirements, then sending that payload to the integration. This can be used as the primary way to run an integration, or to mimic an expected call from a 3rd party service for testing purposes.

Creating a request

Glyue makes it easy to compose the exact request that your integration expects.

  1. To start, right-click on the integration on the Build page and click Run Integration to bring up the Run Integration modal.

  2. If the integration has webservices, use the Method, Prefix, and Webservices dropdowns along the top of the page to select the webservice you wish to trigger.

  3. Configure the content of the request across the Payload, Headers, Query Parameters, and Path Parameters (see below for further details)

To learn more about webservices, see this reference.

Request customization

Payload

Payload refers to information sent in the body of the request. This information can come in various forms, outlined below:

  • JSON: A JSON editor will appear to input JSON-structured content

  • XML: An XML editor will appear to input XML-structured content

  • Multipart: Accepts a combination of uploaded files (up to 10MB) and form data

  • Binary: Accepts a single file (up to 10MB)

  • Empty: The request body will contain no data

Headers

Headers will be automatically populated based on the content of the payload and other details of the integration. When uploading multipart or binary payloads, the Integration Runner will suggest appropriate headers based on the file type(s) that are uploaded.

Some headers are omitted from the display and set automatically when the integration is sent. Certain headers will be ignored even if specified, for security reasons. See the full list ignored/hidden headers in the Appendix.

Query Parameters

To set query parameters (information passed in via the url, e.g. sandbox.com/endpoint?flavor=chocolate ), enter their key and value. New pairs can be added using the green plus button at the top-left.

Notice the url-encoded form of the query parameters will update in the displayed URL along the top of the Integration Runner.

Path Parameters

Integrations with webservices may have variables in the webservice path. These are represented by {variable} in the path name. As you enter values for each path parameter(s), you should see the value(s) update in the displayed URL along the top of the Integration Runner.

All path parameters must have specific values before the request can be executed.

Note that path parameters cannot be added/edited/deleted from this page — modifications to the path occur on the webservice itself.

Re-running an integration

Oftentimes it is useful to re-use the same request, either for simplicity or debugging purposes. This is done by hovering over an entry in the Run History and clicking the re-run icon.

The Run Integration modal will be pre-filled with the same request details as the selected run. If the selected run involved sending Binary or Multipart files, the same files will be re-used by default. Feel free to change the pre-filled values as desired.

Appendix

Ignored headers (will not be sent even if set in Headers tab)

  • accept-encoding

  • connection

  • content-length

  • host

  • user-agent

Hidden headers (automatically set by Gylue on integration execution)

  • authorization

  • content-type

  • origin

  • referer

  • x-csrftoken

PreviousSummaryNextHow to Invite New Users

Last updated