Business Scenario

Adding a Webhook Block

1. Go to Setup > Self Service > Guided Conversations.
   
2. Select the Flow in which you want to add the Webhook block.
   
3. On the Guided Conversations builder, click the Add Block button (  ).
   The Add Block panel will appear on the right.
4. On this panel, click Action Blocks and select Webhook.
   
   
   
   
5. In the Webhook block panel that appears, enter the following details:
   
1. Block name: Enter a name for the block. For example: 'Fetch Contact'
   
2. Method: Choose an API call method from the list.
   
1. Get: Fetches resources from existing contacts.
   
2. Patch: Makes partial changes to be applied to an existing resource.
   
3. Post: Creates or updates an existing resource.
   
4. Put: Modifies a singular resource which is already a part of resources.
   
5. Delete: Deletes an existing resource.
   After this API is executed, the URL in the webhook stops receiving event information.
3. Enter the REST API URL of the third-party application in the URL to notify the field.
   
6. In the Query Params field, click and enter the parameters to sort or filter the resources criteria. For example: @email
   
7. When you choose an API call, you must enter the header, which is the organization ID or the portal ID. This has to be passed as the Header value.
   The API call will perform its action from this portal ID.
   
   
   
   
8. In the Body section, select JSON or File Upload to add fields or upload files respectively.
   
1. Do the following if you choose JSON:
   
1. Mandatory variables: Add those you see marked mandatory in the API document. These are the fields that are available in the third-party or Zoho Services portal and those that need to be mapped by the GC component. To enter a variable value, you must enter a variable and type @, and then choose a variable from the pick-list
2. Custom fields: Include any custom field available in the third-party or Zoho Services portal to the Body section, if required.
   
2. Do the following if you choose File Upload:
   
1. Enter the Key and the Value for the file to be uploaded.
   
9. Click Save.
10. Choose one of the following to create a Connection with the Desk portal.
    
1. Pick Your Service: To create a connection from existing services
   
2. Custom Service: To choose to create a completely new connection
   

Pick your Service

1. Refer to steps 1 to 9 under Adding a webhook block and continue from there.
   
2. Click the Add button besides the Connections label.
   The DRE page will open on a new tab.
3. Under Pick Your Service, choose from the already available third-party services with Zoho, or you can choose one of Zoho services itself.
4. Enter a name for the connection and the connection link.
   Note: You may need to choose the scopes applicable to the service, when prompted.
5. Click Create and Connect.
   
6. Click Accept to allow your organization/portal to connect with the workflow.
   The connection summary page will display, as shown below.
   
   
   
   
7. In the Connections section of the Webhook Block panel, click Refresh to populate the connection name in the drop-down list.
   
8. From the Pick Your Service drop-down list, select the connection name.
   
9. In the Response section, click Status Code and do the following:
1. Enter the expected status code, which you can get from the API document.
   The variable corresponding to the status code will be auto- generated.
2. Enter the response value field which includes the bot variable, response value, type, and data type.
   
3. Click the Plus icon (  ) to add additional bot variables, if necessary.
   
4. Click Save.
   Click Add New Response to add another status code and their corresponding bot variables.
10. Set a time for Request Timeout. Default time out is 8 seconds.
11. Click Save on the webhook block.
12. Click Save Draft on the flow to save your settings.
    
13. Click the Preview button to check if the flow is working.
    

Custom Service

1. Refer to steps 1 to 9 under Adding a webhook block and continue from there.
   
2. Click the Add button besides the Connections label.
   The DRE page will open on a new tab.
3. Choose the Custom Service tab.
   
   
   
   
4. On the Custom Connection page, enter the following service details:
   
1. Service Name
   
2. Service Link Name
   
3. Authentication Type - Choose the authentication type that you want to establish with the connection
   
4. Param Type
   
5. Connection Name
   
6. Connection Link Name
   
5. Click Create and Connect.
6. Click Accept to allow your organization/portal to connect with the workflow.
   The connection summary page will display.
   
7. In the Connections section of the Webhook Block panel, click Refresh to populate the connection name in the drop-down list.
   
8. From the Pick Your Service drop-down list, select the connection name.
   
9. In the Response section, click Status Code and do the following:
1. Enter the expected status code, which you can get from the API document.
   The variable corresponding to the status code will be auto- generated.
2. Enter the response value field which includes the bot variable, response value, type, and data type.
   
3. Click the Plus icon (  ) to add additional bot variables, if necessary.
   
4. Click Save.
   Click Add New Response to add another status code and their corresponding bot variables.
10. Set a time for Request Timeout. Default time out is 8 seconds.
11. Click Save on the webhook block.
    
12. Click Save Draft on the flow to save your settings.
    
13. Click the Preview button to check if the flow is working.