Canopy Connect

Canopy Connect Webhooks API

Get, create, update and delete Webhooks

GitHub OpenAPI
Business capability
Webhook & Event Subscription Management BC-4270.80

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /teams/{teamId}/webhooks List webhooks · GET /webhooks #
Ask an LLM
“Which webhooks are set up on my team?”
“How do I see where webhook requests are being sent?”
Tell an agent
List the webhooks on team {team}.
Show all my webhooks.
POST /teams/{teamId}/webhooks Create a webhook · POST /webhooks #
Ask an LLM
“How do I get notified at my own URL when pulls change?”
“Can I choose which event types trigger a new webhook?”
Tell an agent
Create a webhook on team {team} that sends to {url}.
Add a webhook to {url} for events {events}.
PATCH /teams/{teamId}/webhooks/{webhookId} Update a webhook · PATCH /webhooks/:webhookId #
Ask an LLM
“Can I turn a webhook off temporarily without deleting it?”
“How do I change the event types an existing webhook listens for?”
Tell an agent
Set webhook {webhook} on team {team} active to {active}.
Change webhook {webhook} to trigger on {events}.
DELETE /teams/{teamId}/webhooks/{webhookId} Delete a webhook · DELETE /webhooks/:webhookId #
Ask an LLM
“How do I remove a webhook I no longer use?”
“Can I delete a webhook permanently instead of disabling it?”
Tell an agent destructive · confirm first
Delete webhook {webhook} on team {team}.
Remove webhook {webhook}.

Documentation

📖
Documentation
https://docs.usecanopy.com/reference/getting-started
📖
APIReference
https://docs.usecanopy.com/reference
📖
GettingStarted
https://docs.usecanopy.com/reference/getting-started
📖
Authentication
https://artifacts.apis.io/canopy/authentication/canopy-authentication.yml
📖
RateLimits
https://artifacts.apis.io/canopy/rate-limits/canopy-rate-limits.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/canopy/openapi/canopy-webhooks-api-api-openapi.yml

Other Resources

🔗
Website
https://www.usecanopy.com/
🔗
OAuthScopes
https://artifacts.apis.io/canopy/scopes/canopy-scopes.yml
🔗
ErrorCatalog
https://artifacts.apis.io/canopy/errors/canopy-problem-types.yml
🔗
Conventions
https://artifacts.apis.io/canopy/conventions/canopy-conventions.yml
🔗
Conformance
https://artifacts.apis.io/canopy/conformance/canopy-conformance.yml
🔗
DataModel
https://artifacts.apis.io/canopy/data-model/canopy-data-model.yml
🔗
Examples
https://artifacts.apis.io/canopy/examples/canopy-examples.yml
🔗
Lifecycle
https://artifacts.apis.io/canopy/lifecycle/canopy-lifecycle.yml
🔗
Webhooks
https://artifacts.apis.io/canopy/asyncapi/canopy-webhooks.yml
🔗
ToolCrosswalk
https://artifacts.apis.io/canopy/mcp/canopy-tool-crosswalk.yml
🔗
Security
https://www.usecanopy.com/security

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/canopy:canopy-webhooks-api-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

canopy-webhooks-api-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Reference Webhooks API
  version: 1.0.0
  description: Canopy Connect Public API Documentation
  contact:
    name: Canopy Connect
    email: support@usecanopy.com
    url: https://usecanopy.com/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://app.usecanopy.com/api/v1.0.0
security:
- BasicAuth: []
tags:
- name: Webhooks API
  description: Get, create, update and delete Webhooks
paths:
  /teams/{teamId}/webhooks:
    parameters:
    - schema:
        type: string
        format: uuid
      name: teamId
      in: path
      required: true
      description: ID of Team
    get:
      summary: GET /webhooks
      responses:
        '200':
          description: 200 Response Schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhooks:
                    type: array
                    description: Webhooks available for your API Key type (sandbox or production)
                    items:
                      type: object
                      properties:
                        webhook_id:
                          type: string
                          description: The ID of the Webhook
                          format: uuid
                        signing_secret:
                          type: string
                          description: The secret used to validate webhook requests (https://docs.usecanopy.com/reference/verifying-webhook-signatures)
                        url:
                          type: string
                          description: The URL that the webhook requests go to
                          format: uri
                        is_sandbox:
                          type: boolean
                          description: Whether your API Key and Webhook are sandbox (not production)
                        is_active:
                          type: boolean
                          description: Whether your webhook is active and will receive webhook requests
                        event_types:
                          type: array
                          description: The event types that will trigger the webhook request
                          items:
                            type: string
                            enum:
                            - COMPLETE
                            - POLICIES_AVAILABLE
                            - POLICY_AVAILABLE
                            - AUTH_STATUS
                            - VALIDATION_COMPLETE
              examples:
                Example Response:
                  value:
                    webhooks:
                    - webhook_id: 4dadb30c-95cd-4b17-aa99-0245e4ff6064
                      signing_secret: cBiN66y0wYlbnwJiBu4wRAWceeL8jMJyhH/PjRYzTylTM9IfkJwOZ/Yfwi4dpZM5
                      url: https://www.example.com/canopyConnectWebhook
                      is_sandbox: true
                      is_active: true
                      event_types:
                      - COMPLETE
                      - POLICIES_AVAILABLE
                      - AUTH_STATUS
        '401':
          description: 401 Response Schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                    - UNAUTHORIZED
              examples:
                Example Response:
                  value:
                    error: UNAUTHORIZED
        '403':
          description: 403 Response Schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                    - UNAUTHORIZED
              examples:
                Example Response:
                  value:
                    error: UNAUTHORIZED
      operationId: get-webhooks
      description: Used to get all available webhooks
      tags:
      - Webhooks API
    post:
      summary: POST /webhooks
      operationId: post-webhooks
      responses:
        '200':
          description: 200 Response Schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook_id:
                    type: string
                    format: uuid
                    description: The ID of the Webhook
                  signing_secret:
                    type: string
                    description: The secret used to validate webhook requests (https://docs.usecanopy.com/reference/verifying-webhook-signatures)
              examples:
                Example Response:
                  value:
                    webhook_id: 4dadb30c-95cd-4b17-aa99-0245e4ff6064
                    signing_secret: cBiN66y0wYlbnwJiBu4wRAWceeL8jMJyhH/PjRYzTylTM9IfkJwOZ/Yfwi4dpZM5
        '400':
          description: 400 Response Schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                    - INVALID_URL
                    - INVALID_EVENT_TYPE
        '401':
          description: 401 Response Schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                    - UNAUTHORIZED
              examples:
                Example Response:
                  value:
                    error: UNAUTHORIZED
        '403':
          description: 403 Response Schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                    - UNAUTHORIZED
              examples:
                Example Response:
                  value:
                    error: UNAUTHORIZED
      description: Used to create a webhook
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                hookUrl:
                  type: string
                  description: The URL that the webhook requests will go to
                  format: uri
                eventTypes:
                  type: array
                  description: The event types that will trigger the webhook request
                  items:
                    type: string
                    enum:
                    - COMPLETE
                    - POLICIES_AVAILABLE
                    - POLICY_AVAILABLE
                    - AUTH_STATUS
                    - VALIDATION_COMPLETE
      tags:
      - Webhooks API
  /teams/{teamId}/webhooks/{webhookId}:
    parameters:
    - schema:
        type: string
        format: uuid
      name: teamId
      in: path
      required: true
      description: ID of Team
    - schema:
        type: string
        format: uuid
      name: webhookId
      in: path
      required: true
      description: ID of Webhook
    patch:
      summary: PATCH /webhooks/:webhookId
      operationId: patch-webhook
      responses:
        '200':
          description: 200 Response Schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
              examples:
                Example Response:
                  value:
                    success: true
        '400':
          description: 400 Response Schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                    - NOT_FOUND
                    - INVALID_IS_ACTIVE
                    - INVALID_EVENT_TYPE
                    - INVALID_WEBHOOK_ID
              examples:
                Example Response:
                  value:
                    error: NOT_FOUND
        '401':
          description: 401 Response Schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                    - UNAUTHORIZED
              examples:
                Example Response:
                  value:
                    error: UNAUTHORIZED
        '403':
          description: 403 Response Schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                    - UNAUTHORIZED
              examples:
                Example Response:
                  value:
                    error: UNAUTHORIZED
      description: Used to update a webhook
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                isActive:
                  type: boolean
                  description: Whether your webhook is active and will receive webhook requests
                eventTypes:
                  type: array
                  description: The event types that will trigger the webhook request
                  items:
                    type: string
                    enum:
                    - COMPLETE
                    - POLICIES_AVAILABLE
                    - POLICY_AVAILABLE
                    - AUTH_STATUS
                    - VALIDATION_COMPLETE
        description: ''
      tags:
      - Webhooks API
    delete:
      summary: DELETE /webhooks/:webhookId
      operationId: delete-webhook
      responses:
        '200':
          description: 200 Response Schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
              examples:
                Example Response:
                  value:
                    success: true
        '400':
          description: 400 Response Schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                    - INVALID_WEBHOOK_ID
              examples:
                Example Response:
                  value:
                    error: INVALID_WEBHOOK_ID
        '401':
          description: 401 Response Schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                    - UNAUTHORIZED
              examples:
                Example Response:
                  value:
                    error: UNAUTHORIZED
        '403':
          description: 403 Response Schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                    - UNAUTHORIZED
              examples:
                Example Response:
                  value:
                    error: UNAUTHORIZED
      description: Used to delete a webhook
      tags:
      - Webhooks API
components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication. Use your Canopy Connect Client ID as the username and your Client Secret as the password. The `Authorization` header value is `Basic <base64 of clientId:clientSecret>`. See the [Authentication guide](https://docs.usecanopy.com/reference/authentication-guide) for a full walkthrough, and create or manage your Client ID and Client Secret on the [API Settings page](https://app.usecanopy.com/dashboard/settings/api-settings).
x-readme:
  headers: []
  explorer-enabled: true
  proxy-enabled: true
  samples-enabled: true
x-provenance:
  method: harvested
  publisher: Canopy Connect
  source: https://docs.usecanopy.com/openapi/documentation.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)