1. Docs
  2. API Reference
  3. Get a webhook subscription

Get a webhook subscription

GET/api/v1/webhooks/{id}

Returns a single webhook subscription by id, scoped to the active Application's current Environment, with metadata only — the signing secret is never re-disclosed. Returns 404 when the subscription does not exist in this Environment. Requires the webhook.view permission.

Authentication

Bearer TokenAuthorization Option A

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

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Path Parameters

idstring Required

Responses

application/json

  • dataWebhookResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

WebhookResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/webhooks/value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "data": {
    "id": "string",
    "scope": "environment",
    "url": "string",
    "event_types": [
      "string"
    ],
    "description": "string",
    "is_active": false,
    "created_at": "2026-04-20T12:00:00.000Z"
  }
}
 Related endpoints
GETList webhook subscriptions
POSTCreate a webhook subscription
GETList subscribable webhook event types
GETList delivery attempts for a webhook
PATCHUpdate a webhook subscription
DELETEDelete a webhook subscription
 Was this page helpful?

Tell us how we can improve this guide.

Canopy