Retrieving webhook-enabled workflows

Retrieve details of workflows that are webhook-enabled.

1. In a REST client platform, add the authentication details of the tenant from where you want to retrieve details of webhook-enabled workflows.

   
   //In case of Instance API key 
   Headers:
   {
   "x-instance-api-key": "instance_api_key"
   }
    
   // In case of MCSP or ISV token
   Headers:
   {
   "Authorization": "mcsp_or_isv_token"
   }
   

2. Make a GET request at the URL of the project.
   URL Syntax: <domain>/apis/v1/rest/projects/:project/webhook-flows

   In this URL request, /:project is the name of the project from where you want to retrieve details of webhook-enabled workflows.

   You can control and filter the output response by using the URL query parameters. Consider the following points in the URL request:

   • To skip some pages at the beginning of the collection in the response, append the query parameter ?skip=n to the URL request, where n is the number of pages you want to skip.
   • If you want to define the maximum page size to start from the n-th one, append ?limit=m to the URL request. Where m is the total number of records that you want to include in the response.

   Method: GET

   If the request is successful, you receive the response code for success.

   {
   output: 
   	{
   	"objects": 
   		[
   		{
   		"uid": "<workflow_uid>",
   		"sid": <workflow_sid>
   		"name": "<workflow_name>",
   		"tenant_uid": "<tenant_uid>",
   		"project_uid": "<project_uid>",
   		"webhook_settings": <workflow_webhook_settings>               
   		}        
           ],
   	"count": <webhook_workflow_count>
   	}
   }