Glyue User Docs
  • What is Glyue?
  • Tutorials
    • Start Here
    • Building a Single-Step Integration
      • 1. Creating the Integration
      • 2. Calling the External System
      • 3. Running the Integration
      • 4. Crafting the Output
    • Building a Multi-System Integration
      • 1. Connecting to the Core
      • 2. Field Mapping
      • 3. Running the Integration
    • Building an Event-Driven Integration
      • 1. Setting up the Mock CRM
      • 2. Receiving Inbound Requests
      • 3. Triggering the Integration from the CRM
    • Building an Email Integration
      • 1. Create and Configure the Integration
      • 2. Input Validation
      • 3. Get Story IDs from Hacker News
      • 4. Get Story Content
      • 5. Sending the Email
      • 6. Wrapping Up
      • 7. Extra credit
        • extra_credit.json
    • Building a RESTful CRUD Web Service
      • 1. Integration Setup
      • 2. Vault Setup
      • 3. Create Web Service Endpoints
      • 4. Execute Web Service Endpoints with Vault Methods
      • 5. Vault Code Examples and Explanation
    • Building a Retrieval API against FIS CodeConnect
      • 1. Integration Setup
      • 2. Service Request Setup
      • 3. Field Mapping Setup
      • 4. Integration and Service Request Hook Setup
      • 5. Testing the Integration
      • 6. Common Errors
    • What is Pre-Mapping?
      • Before you start
      • Bookmarks
      • Source and Targets
      • Field Mapping Status
      • Field Mapping Comments
      • Summary
  • How-To Guides
    • How to Run an Integration from Glyue
    • How to Invite New Users
    • How to Create a Value Mapping Set
    • How to Build and Deploy a Custom Frontend
    • How to Migrate an Integration
    • How to Set Up Single Sign On (SSO)
      • Glyue Setup
      • JumpCloud Setup
      • Azure Setup
      • Okta Setup
      • Glyue SAML Config Reference
    • How to Install the Glyue App for Zoom Contact Center
    • How to use the Vault
  • Reference
    • Integration Builder Page
    • Integration Anatomy
    • Integration Components
      • Integration
      • Service Request
      • Field Mapping
      • Value Mapping Set
      • Value Mapping
      • Validation Rule
      • Mask
      • Integration Config
      • Integration Engine Versions
    • Integration Lifecycle
    • Special Functions
      • add_run_label
      • callint
      • debug
      • end
      • get_namespace
      • humanize
      • import_helper
      • keep
      • list_files
      • map_value
      • open_glyuefile
      • open_vault
      • Data Manipulation Utilities
      • calladapter
    • Special Variables
      • __adapter_config__
      • input
      • parentint
      • retvalue
      • run_history_id
      • Iterables
        • fitem/fidx
        • sritem/sridx
        • vritem/vridx/vrmsg
    • Adapters
      • Generic HTTP Adapter
      • Email SMTP Adapter
    • Web Service Endpoints
    • Vault Reference
  • Glyue Platform Reference
    • Banking Core Connectivity Guide
    • Authentication
    • Permissions
      • Service Accounts
      • Organizations
    • Frontends
    • Idempotency Layer
    • Integration Scheduler
    • Governance Reports
    • Arbitrary Integration Request Content Support
    • Admin Components
    • Logging
  • ETL
    • Glyue ETL Overview
    • Data Connectors
    • Workflows
    • Run History
    • Scheduler
Powered by GitBook
On this page
  • integration
  • parent_servicerequest
  • sequence
  • system
  • service_name
  • formula_variable
  • call_if
  • call_for_each
  • abort_after_execute_request_failure
  • skip_execute_if_no_sub_requests
  • message_substitution_name
  • notes
  • Lifecycle Hooks

Was this helpful?

  1. Reference
  2. Integration Components

Service Request

integration

relationship - required

The integration that the service request is related to.

parent_servicerequest

relationship - required

If specified, the service request will be attached to another service request.

sequence

integer - required

Order in which the service requests associated with the integration will execute, from lowest (first) to highest (last). Service requests with the same sequence will be run in arbitrary order.

system

string - required

The external system being called by the service request. Banking-specific systems are identified by name, otherwise the HTTP adapter is suitable for connecting to arbitrary systems.

service_name

string - required

The API service being called within the target system. Usage specifics vary from system to system.

formula_variable

string - required

The name of the variable that will contain the requestand response values of this service request. If the service request uses call_for_each , requestand response will be lists of objects.

This variable can be accessed in subsequent service requests, field mappings, or lifecycle hooks of the integration as a means to pass data.

call_if

code block - optional

This expression must return a boolean. If it resolves to True , the service request will be run. If left empty, the service request will always run.

call_for_each

iterable - optional

Resolves before the call_if block.

abort_after_execute_request_failure

boolean - optional

Determines whether the integration should quit if the call to the external system fails. By default, the integration will not quit (false). When set to true , the integration's after_overall_failure_hook will still run, as well as the service request's after_execute_request_failure_hook.

skip_execute_if_no_sub_requests

string - optional

message_substitution_name

string - optional

Replaces the name of the service with specified string in error messages. Useful to improve readility of errors for non-technical customers.

notes

string - optional

Documentation field, internal to Glyue.

Lifecycle Hooks

None are required for a service request to function.

  • before_prepare_request_hook

  • after_prepare_request_success_hook

  • after_prepare_request_failure_hook

  • before_execute_request_hook

  • after_execute_request_success_hook

  • after_execute_request_failure_hook

  • after_overall_success_hook

  • after_overall_failure_hook

PreviousIntegrationNextField Mapping

Last updated 3 months ago

Was this helpful?

Specifies an iterable. The service request will run once for every entry in the iterable. Within other code blocks or field mappings of the service request, the specific entry in the iterable can be accessed using and its index via .

These are code blocks that are run during lifecycle of the service request. They are equivalent in function, differentiated only by the time at which they are executed. See the for a visual explanation of hook timing.

Service Request Lifecycle
sritem
srindex