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
  • Activating the Idempotency Layer
  • Responses from the Idempotency Layer
  • Sample Client Code

Was this helpful?

  1. Glyue Platform Reference

Idempotency Layer

PreviousFrontendsNextIntegration Scheduler

Last updated 4 months ago

Was this helpful?

Glyue features a built-in layer for all integrations that enables callers of integrations to retry requests without concern of unintentionally duplicating the operation.

When the Idempotency-Key header is present, any subsequent calls from the same account with the same Idempotency-Key value will be treated as a duplicate request and will be returned the same response as the initial request without re-running the integration.

Resending a request with an already-used Idempotency-Key is most appropriate when the client does not receive a response from Glyue, e.g. due to a network connectivity drop. In such situations, retrying a request with the same Idempotency-Key will allow the client to safely determine whether the operation actually succeeded, or if it should try again with a new Idempotency-Key.

Activating the Idempotency Layer

To activate the idempotency layer, add the Idempotency-Key header to the request with the unique ID.

Glyue guarantees that integrations will not be re-run if they are called with:

  • The same idempotency key

  • From the same Glyue account

  • Within a 24 hour period from the original request

Instead, the status and response of the first run will be returned.

IDs may be up to 64 characters long.

It is strongly recommended that a UUID generator is used to create the idempotency ID.

Responses from the Idempotency Layer

When the idempotency layer detects a duplicate request, it will send a response that contains the same body, status, and headers that were sent in the original response. It contains no indication that the request was captured by the idempotency layer.

In Glyue's Run History, duplicate requests are denoted by the IDEMPOTENT_REQUEST flag within the integration run's steps.

Sample Client Code

Include the Idempotency-Key header in your request, setting its value to a unique key. Generate a new key for each request and retain the key for a given request until you are certain you no longer need to retry it.

curl --location 'https://glyuedev.yourdomain.sandboxbanking.com/execute/path/to/integration/here' \
--header 'Idempotency-Key: IDEMPOTENCY_KEY_HERE' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic ENCODED_BASIC_AUTH_HERE' \
--data '{
    "foo": "bar"
}'

If a duplicate request (with the same Idempotency-Key) is sent before the original request finishes, the idempotency layer will response with an . The integration will not be re-run.

idempotency
HTTP 409 status