Integration

active

boolean - required

Defines whether the integration can be run at all. If set to false , the integration cannot be run via an HTTP request (regardless of the value of http_api), and the integration cannot be run via the callint function.

path_name

string - required

The exposed endpoint for the integration. Integrations are called from {host}/integrations/execute/{path_name}

description

Documentation field providing an overview of the integrations functions.

http_api

boolean - required

Determines whether or not an integration can be run via an HTTP request over the web.

When enabled, the integration can be called from {host}/integrations/execute/{path_name} or any configured webservice endpoints.

When disabled, the integration can only be called from another Glyue integration, via the callint function.

run_async

boolean - required

Controls whether to run the integration synchronously. If true , Glyue will immediately return a 200 response without waiting for the integration to finish executing.

Useful for long-runnings tasks that may otherwise cause timeouts on clients, or in combination with callint to spawn additional processes.

Lifecycle Hooks

For a visual explanation of the timing of these hooks, see the Integration Lifecycle diagram.

before_hook

expression - optional

A block of code that executes prior to the initialization of the integration.

on_failure_hook

expression - optional

A block of code that runs only upon an integration failure, prior to the finally hook.

on_success_hook

expression - optional

A block of code that runs only upon a successfully completed integration, prior to the finally hook.

finally_hook

expression - optional

A block of code that executes prior to the completion of an integration. This block will always run regardless of integration status.

Swagger

Glyue has an integrated swagger page to allow for easy endpoint execution from within Glyue. The swagger request and response fields allow for the specification of swagger request bodies and sample responses. These must be formatted in line with the OpenAPI Specification. Swagger

swagger_request

Swagger Request Body - This field is scoped to the requestBody of the OAS 3 specification

{ "content": {
    "application/json": {
        "schema": {
            "type": "string", 
            "example": "sample string input" 
            } 
        } 
    } 
}

swagger_response

The input is scoped to the responses on the OAS 3 specification.

{ "200": {
     "description": "Sample Response", 
     "content": { 
           "application/json": { 
                "schema": {
                     "type": "string", 
                     "example": 
                     "Example Object" 
                     }
                }
           }
      } 
}