Sign a transaction with Overledger API on New Requests from HTTP / Webhook API

Pipedream makes it easy to connect APIs for Overledger, HTTP / Webhook and 2,400+ other apps remarkably fast.

Trigger workflow on

New Requests from the HTTP / Webhook API

Next, do this

Sign a transaction with the Overledger API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a HTTP / Webhook trigger and Overledger action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Requests trigger
1. Optional- Configure Body Only
2. Optional- Configure Response Status Code
3. Optional- Configure Response Content-Type
4. Optional- Configure Response Body
5. Connect your HTTP / Webhook account
Configure the Sign a transaction action
1. Connect your Overledger account
2. Select a Overledger Instance
3. Select a Location Technology
4. Configure Signing Account ID
5. Configure Request ID
6. Configure Transaction Signing Responder Name
7. Configure Native Data
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Requests on HTTP / Webhook

Description:Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Version:0.1.1

Key:http-new-requests

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

import http from "../../http.app.mjs";

// Core HTTP component
export default {
  key: "http-new-requests",
  name: "New Requests",
  description: "Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.",
  version: "0.1.1",
  type: "source",
  props: {
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    emitBodyOnly: {
      type: "boolean",
      label: "Body Only",
      description: "This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.",
      optional: true,
      default: false,
    },
    resStatusCode: {
      type: "string",
      label: "Response Status Code",
      description: "The status code to return in the HTTP response",
      optional: true,
      default: "200",
    },
    resContentType: {
      type: "string",
      label: "Response Content-Type",
      description: "The `Content-Type` of the body returned in the HTTP response",
      optional: true,
      default: "application/json",
    },
    resBody: {
      type: "string",
      label: "Response Body",
      description: "The body to return in the HTTP response",
      optional: true,
      default: "{ \"success\": true }",
    },
    http,
  },
  async run(event) {
    const summary = `${event.method} ${event.path}`;

    this.httpInterface.respond({
      status: this.resStatusCode,
      body: this.resBody,
      headers: {
        "content-type": this.resContentType,
      },
    });

    if (this.emitBodyOnly) {
      this.$emit(event.body, {
        summary,
      });
    } else {
      this.$emit(event, {
        summary,
      });
    }
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
N/A	`httpInterface`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Body Only	`emitBodyOnly`	`boolean`	This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.
Response Status Code	`resStatusCode`	`string`	The status code to return in the HTTP response
Response Content-Type	`resContentType`	`string`	The `Content-Type` of the body returned in the HTTP response
Response Body	`resBody`	`string`	The body to return in the HTTP response
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

Sign a transaction on Overledger

Description:Sign a transaction using Overledger - Part 2 of [Overledger Pattern](https://developers.quant.network/reference/overledger-pattern). [See documentation](https://developers.quant.network/reference/sandboxsigning)

Version:0.0.1

Key:overledger-sign-a-transaction

View on GitHub

Overledger Overview#

The Overledger API by Quant Network allows developers to interact with multiple blockchain networks. It facilitates the creation, reading, and execution of smart contracts and transactions across different blockchains. This API simplifies the complex nature of blockchain interoperability, enabling multi-chain applications (MApps) through a single gateway.

Action Code#

import overledger from "../../overledger.app.mjs";
import { TECHNOLOGY_OPTIONS, UNIT_OPTIONS } from "../../common/constants.mjs";

export default {
  key: "overledger-sign-a-transaction",
  name: "Sign a transaction",
  description: "Sign a transaction using Overledger - Part 2 of [Overledger Pattern](https://developers.quant.network/reference/overledger-pattern). [See documentation](https://developers.quant.network/reference/sandboxsigning)",
  version: "0.0.1",
  type: "action",
  props: {
    overledger,
    environment: {
      propDefinition: [
        overledger,
        "environment",
      ],
    },
    locationTechnology: {
      type: "string",
      label: "Location Technology",
      description: "The blockchain technology used for this transaction, e.g., ethereum, substrate - required in order to set the dltfee",
      options: TECHNOLOGY_OPTIONS,
      reloadProps: true,
    },
    keyId: {
      type: "string",
      label: "Signing Account ID",
      description: "The ID/address of the blockchain account that will sign the transaction.",
    },
    requestId: {
      type: "string",
      label: "Request ID",
      description: "The Request ID assigned to a preparation request in Overledger. This should be set to the requestId parameter found in the response object of the 'Prepare Transaction' Overledger action.",
    },
    transactionSigningResponderName: {
      type: "string",
      label: "Transaction Signing Responder Name",
      description: "The name of the Transaction Signing Responder you would like to use. The CTA Transaction Signing Responder is the Quant-provided signer for testnet accounts.",
    },
    nativeData: {
      type: "object",
      label: "Native Data",
      description: "An object representing the transaction required to be signed - This should be set to the nativeData object of the 'Prepare Transaction' Overledger action.",
    },
  },
  async run({ $ }) {
    //default values of gatewayFee and dltfee hard coded into params.
    const gatewayFee = {
      amount: "0",
      unit: "QNT",
    };
    // Define DLT Fee and dynamically set the 'unit/symbol' from UNIT_OPTIONS
    const dltFee = {
      amount: "0.000019897764079968",
      unit: UNIT_OPTIONS[this.locationTechnology] || "ETH", // Use default if not found
    };
    // Sign the transaction
    const requestBody = {
      keyId: this.keyId,
      gatewayFee: gatewayFee,
      requestId: this.requestId,
      dltFee: dltFee,
      nativeData: this.nativeData,
      transactionSigningResponderName: this.transactionSigningResponderName,
    };

    const response = await this.overledger.signTransaction({
      $,
      environment: this.environment,
      data: requestBody,
    });
    $.export("$summary", "Transaction signed successfully");
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Overledger	`overledger`	`app`	This component uses the Overledger app.
Overledger Instance	`environment`	`string`	Select a value from the drop down menu:`{ "label": "Sandbox", "value": "sandbox" }{ "label": "Overledger", "value": "overledger" }`
Location Technology	`locationTechnology`	`string`	Select a value from the drop down menu:`{ "label": "Ethereum", "value": "ethereum" }{ "label": "Substrate", "value": "substrate" }{ "label": "XRP Ledger", "value": "xrp ledger" }{ "label": "Bitcoin", "value": "bitcoin" }{ "label": "Hyperledger Fabric", "value": "hyperledger fabric" }`
Signing Account ID	`keyId`	`string`	The ID/address of the blockchain account that will sign the transaction.
Request ID	`requestId`	`string`	The Request ID assigned to a preparation request in Overledger. This should be set to the requestId parameter found in the response object of the 'Prepare Transaction' Overledger action.
Transaction Signing Responder Name	`transactionSigningResponderName`	`string`	The name of the Transaction Signing Responder you would like to use. The CTA Transaction Signing Responder is the Quant-provided signer for testnet accounts.
Native Data	`nativeData`	`object`	An object representing the transaction required to be signed - This should be set to the nativeData object of the 'Prepare Transaction' Overledger action.

Action Authentication#

Overledger uses OAuth authentication. When you connect your Overledger account, Pipedream will open a popup window where you can sign into Overledger and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Overledger API.

Pipedream requests the following authorization scopes when you connect your account:

overledger/read.scope

About Overledger#

Overledger Platform. The enterprise standard for building on blockchain.

More Ways to Connect Overledger + HTTP / Webhook#

Other Popular Integrations#

Execute Signed Transaction with Overledger API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Overledger