Webhook

Webhook

Webhook enables communication between third-party applications and Zoho Circuit. With webhooks, you can make API calls and notify the applications whenever an action takes place in Zoho Circuit.
 
Set up webhooks in the following three steps:
  1. Create a Webhook
  2. Integrate Webhook to a Circuit
  3. Test your Integration

Create a Webhook 

To create a Webhook:
  1. Log in to the Zoho Circuit console.
  2. Click +Create New in the top-right corner, then select Webhook. The Create New Webhook page will appear.
  3. Specify a unique Name for the Webhook.

  4. In URL to notify, enter the API URL of the third-party application.
  5. Select the type of API Method -GET or POST. By default, the system selects the GET method.
  6. Add a Description for the webhook.
  7. Under Custom Parameters, specify the parameter name and parameter value. These parameters will be sent to the third-party application while triggering the webhook. Custom Parameters are optional fields.
  8. Specify the Custom Headers with header name and header value. The configured headers will be appended to the API request while triggering the webhook. Custom Headers are also optional fields.
  9. Click Create. 
      

           
The webhook is listed under Settings [] → Developer Space → Webhooks.

Integrate Webhook to a Circuit

To integrate a webhook to a circuit:
  1. Log in to Zoho Circuit console and select Circuits from the top menu.'
  2. Select the circuit you'd like to modify, then click the Edit icon [].
  3. In the displayed circuit, drag and drop the Webhook state from the Functional States pane on the left.


  4. Enter a unique name for the webhook state.
  5. Select the Previous State and Next State between which the new webhook state has to be added, then click Create. 
  6. Under Configuration on the right, you can optionally edit the state Name.
  7. Type 'Webhook' is selected by default. Select the Webhook Name to be added to the circuit from the drop-down list.
  8. The Next State selected during state creation is displayed. If you'd like to change it, select a state from the dropdown.
  9. Specify the Error Handling options for the state. To learn more about Error Handling, click here.
     

  10. Under Input / Output on the right, enter Input Path, Output Path and Result Path. To learn more about I/O paths, click here.
  11. 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'.
    1. Add Parameter - Specify the parameter name and parameter value. These parameters will be sent to the third-party application while triggering the webhook. 
    2. Add Header - Specify the header name and header value. The configured headers will be appended to the API request while triggering the webhook.
  12. Click Save.

Test your Integration

To test your integration,
  1. After saving your circuit, click Test Run at the top.
  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.
  4. Click Run. To learn more about Executions,  click here.
  5. Check for the data received from Zoho Circuit through the Webhook notification in your application.
  6. If there is a failure or data mismatch, modify your webhook settings in Zoho Circuit.
  7. Repeat this test until you get the required data from Zoho Circuit to your application.