OrgsWebhooks

countOrgWebhooksDeliveries

GET
/api/v1/orgs/{org_id}/webhooks/{webhook_id}/events/count

Count Org Webhooks deliveries

Topics Supported:

  • alarms
  • audits
  • device-updowns
  • occupancy-alerts
  • ping

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid
webhook_id*string
Formatuuid

Query Parameters

error?string

Filter webhook delivery results by error message

status_code?integer

Filter webhook delivery results by HTTP status code

status?string

Webhook delivery status used to filter results. enum: failure, success

Value in

  • "failure"
  • "success"
topic?string

Webhook topic used to filter results. enum: alarms, audits, device-updowns, occupancy-alerts, ping

Value in

  • "alarms"
  • "audits"
  • "device-updowns"
  • "occupancy-alerts"
  • "ping"
distinct?string

Field used to group this count response. enum: status, status_code, topic, webhook_id

Value in

  • "status"
  • "status_code"
  • "topic"
  • "webhook_id"
start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

duration?string

Time range duration for the query, using relative units such as 10m, 7d, or 2w

Default"1d"
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/webhooks/000000ab-00ab-00ab-00ab-0000000000ab/events/count"
{  "distinct": "string",  "end": 0,  "limit": 0,  "results": [    {      "count": 0,      "property": "string"    }  ],  "start": 0,  "total": 0}