Integration

Parameters

path_name

string - required

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

description

Documentation field providing an overview of the integrations functions.

run_async

boolean - required

Boolean flag on whether to run the integration synchronously. Ideal for longer running tasks or in combintaion with callint to spawn additional processes.

before_hook

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

finally_hook

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

on_failure_hook

code block that runs after a failed integration but prior to the finally hook.

on_success_hook

code block that runs after a successful integration but prior to the finally hook.

http_api

boolean - required

A Boolean flag for whether this integration should be exposed. This allows for integrations to be called from {glyue_host}/integrations/execute/{path_name}

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" 
                     }
                }
           }
      } 
}