1. Docs
  2. API Reference
  3. Active/inactive webhook counts for the environment

Active/inactive webhook counts for the environment

GET/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/webhooks/summary

Returns active/inactive subscription counts for the Account's webhooks at the account scope, with an optional q substring filter on the delivery URL. Requires webhook.view.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Requires capability env_webhooks.viewDeveloper Console

View Environment webhook subscriptions and deliveries. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

The Environment's slug within the Application.

Query Parameters

qstring Optional

Responses

application/json

  • dataActiveSummaryDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

ActiveSummaryDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/webhooks/summary?q=value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "active_count": 0,
    "inactive_count": 0
  }
}
 Related endpoints
GETList webhook subscriptions
POSTCreate a webhook subscription
GETList subscribable webhook event types
GETList delivery attempts for a webhook
GETGet a webhook subscription
PATCHUpdate a webhook subscription
DELETEDelete a webhook subscription
POSTRotate a webhook subscription's signing secret
 Was this page helpful?

Tell us how we can improve this guide.

Canopy