Get webhook action usage reports

GET/settings/automation/webhooks/actions/usage_reports

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Get webhook action usage reports action (under Webhooks).
Fill in the fields below, then reference the result from later steps as {{getWebhookActionUsageReports.response.data}}.

Request

Query parameters

group_bystringrequired

Specify the grouping criteria for usage data. Must include date. Possible values: **date** - Returns daily totals; the resource object is omitted from each row. **date,resource** - Returns per-action rows including resource.id and resource.name. **date,resource,type** - Returns per-action rows grouped by resource and type.

One ofdatedate,resourcedate,resource,type

typestring

Specify the automation feature type to filter usage data. When omitted, usage across all supported feature types is returned. Possible values: **workflow_rules** - Workflow Rules. **approval_process** - Approval Process. **blueprint** - Blueprint. **orchestrations** - Orchestrations. **wizards** - Wizards. **modules** - Modules. **webhooks** - Webhooks. **kiosks** - Kiosks.

One ofworkflow_rulesapproval_processblueprintorchestrationswizardsmoduleswebhookskiosks

fromstring (date)

Specify the start date (inclusive) for the query window in YYYY-MM-DD format, evaluated in the organization's time zone. For webhook_failures, defaults to 30 days before **to**; earlier dates are clamped to that 30-day window. For usage_reports, defaults to 30 days before **to**. Future dates return 400 INVALID_DATA.

tostring (date)

Specify the end date (inclusive) for the query window in YYYY-MM-DD format, evaluated in the organization's time zone. Defaults to the current date at 23:59:59 when omitted. Must be on or after the **from** date. Future dates are rejected.

pageinteger (int32)

Specify the page number for paginated results. Defaults to 1 when omitted. Use together with per_page to navigate large result sets.

per_pageinteger (int32)

Specify the number of records to return per page. Default and maximum is **200**.

sort_orderstring

Specify the sort direction for list results. Defaults to desc when omitted. Possible values: **asc** - Ascending order. **desc** - Descending order.

One ofascdesc

include_inner_detailsstring

Specify to request additional nested fields within usage report resource objects. Currently, only resource.layout_id is recognized; it adds layout_id inside the resource object when available, primarily for wizard usage rows. Other values are silently ignored.

One ofresource.layout_id

Response

Returns 200 with an object. Read it in later steps with {{getWebhookActionUsageReports.response.data.<field>}}.

data_usagearray<object>

Contains the collection of usage data points for the queried period. Each entry represents the execution count for a specific automation action on a given date. Returns an empty array when no usage exists for the queried period.

datestring (date)

Represents the date of this usage data point in YYYY-MM-DD format. All dates are evaluated in the organization's time zone.

resourceobject3 fields

Represents a reference to the specific automation action that generated usage. The identifier and name are resolved from the action's configuration record; for deleted actions, the name falls back to the corresponding automation audit log entry. When the include_inner_details parameter includes resource.layout_id and the action is associated with a wizard layout, a layout_id field is included in the representation.

countinteger (int32)

Represents the number of times the automation action was executed on this date. When the group_by parameter is set to 'date' only, this value reflects the total across all actions.

typestring

Represents the automation feature type associated with the reported executions. Values correspond to the filter types supported by the type query parameter, such as workflow_rules, approval_process, Blueprint, email_notifications, webhooks, and kiosks.

infoobject

Represents pagination metadata returned with automation usage report responses. Includes a max_limit value that reflects the edition-specific daily execution cap for the relevant action type, derived from the organization's feature limits.

per_pageinteger (int32)

Represents the number of records returned in each page of the result set.

countinteger (int32)

Represents the number of records included in the current page of results.

pageinteger (int32)

Represents the one-based index of the current page within the paginated result set.

more_recordsboolean

Indicates whether additional pages of results are available beyond the current page. Possible values: true - More records exist beyond the current page. false - The current page contains the last records.

max_limitinteger (int32)

Represents the edition-specific daily execution cap for the automation action type. For email notifications, this reflects the WORKFLOWALERT day limit; for webhooks, it reflects the WFWEBHOOK day limit. Lower-tier editions carry smaller caps.

json

{
  "data_usage": [
    {
      "date": "2025-10-23",
      "resource": {
        "id": "5586800000123001",
        "name": "Notify Deal Owner",
        "layout_id": "738964000000100045"
      },
      "count": 0,
      "type": "string"
    }
  ],
  "info": {
    "per_page": 200,
    "count": 4,
    "page": 1,
    "more_records": false,
    "max_limit": 2500
  }
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?