Configure Webhook in Circuit | Circuit | Qntrl | Online Help

Webhook

Webhook promotes communication between Circuit and third-party applications. With webhooks, you can make API calls and trigger notifications when a predefined action is performed as per the business requirement.
 
Prerequisite

Create a webhook that has to be executed in a bridge by giving relevant field details. Click here to learn how to create a webhook in Qntrl.

 

Example Use Case: When it comes to the employee onboarding process, the Webhook state can be employed for electronic document verification procedures. This is accomplished by establishing a connection between the verification service provider and configuring it to transmit verification results or updates to your webhook endpoint. By analyzing the response received, the subsequent course of action can be configured.

Builder View

In Builder View, to integrate a webhook in circuit:
  1. Drag and drop the Webhook state from the left pane into your circuit, or click the required webhook state in your circuit.
  2. Under Configuration, update the common state field attributes.
  3. In the Type field, Webhook is selected by default. Select the Webhook Name to be added to the circuit from the drop-down list.
  4. Specify the Error Handling options for the state. Learn more about Error Handling.
 
    

  1. Under Input / Output in the right pane, you can optionally fill in the following details:
    • Enter the Input Path, Output Path, Result Path, and Result selector. Learn more about I/O paths.
    • In the Body, the data bytes required to send the request data are given.
    • In addition to the custom parameters and custom headers configured for the webhook, define dynamic parameters and headers specific to this Webhook state and this circuit using Add Parameter and Add Header.
      • Add Parameter - Specify the parameter name and parameter value. These parameters will be sent to the third-party application while triggering the webhook.
      • Add Header - Specify the header name and header value. The configured headers will be appended to the API request while triggering the webhook.  
  

​
  1. Click Save and Execute.
  2. Specify the test data as Input JSON for your test run, then click Next.
  3. Name your test run by providing a unique name for this execution. Click Run.
  4. Check for the data received from Qntrl Circuit through the webhook notification in your application.
  5. If there is a failure or data mismatch, modify your webhook settings in the Qntrl Circuit.
  6. Repeat this test until you get the required data from Circuit to your application.

Code View

The JSON for configuring a webhook in Code View is given below:

"Verify Employee Documents": {
	"type": "webhook",
	"next": "Action - Approve or Reject",
	"webhook_id": "employee_document_verification_1",
	"parameters": {
		"pan_number": "pan.number"
	},
	"headers": {
		"AuthorizationKey": "$.APIkey"
	}
}







Next: Circuit state

    • Related Articles

    • Manage Webhooks

      Webhooks Overview Webhooks facilitate automated HTTP notifications. Notifications are triggered in third-party applications as per the business requirements when a predefined action is performed by the user in the organization. Business Use Cases of ...

    • Configuring Additional Components

      Webhooks Create a Webhook To create a new Webhook: Click Webhook in the left pane and click New Webhook. Fill in the following details: Type: Select Standalone (the only supported type for Circuit). Name: Enter a name for the webhook. URL: Specify ...

    • Events

      Early Access Events module is not enabled for all users. If you’d like to try it out, please email our support team for early access. In either scenario, whether your bridge is successfully connected and operational, or experiencing unforeseen ...

    • Task Engine

      Circuit's Task Engine state is used to connect with other applications and access APIs from a closed space. To retrieve data from a private network, the required API must be accessed from the local machine's network for the required conditions. ...

    • Batch

      Batch state allows you to execute a function, webhook, or circuit in batches as multiple jobs in an iterative manner. While the Parallel state executes multiple states simultaneously using the same input, the Batch state executes the (same set of) ...

    You are currently viewing the help articles of Qntrl 3.0. If you are still using our older version and require guidance with it, Click here.