For AI agents: visit https://docs.usecanopy.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Canopy ConnectCanopy Connect
DocumentationDeveloper PlansRequest AccessAgent Help
Canopy Connect
Documentation
Jump to Content
Canopy ConnectCanopy Connect
DocumentationDeveloper PlansRequest AccessAgent Help

Overview

  • Getting Started
  • Sandbox Credentials
  • Common Issues

API Credentials

  • Authentication
  • Canopy Connect Apps
    • Creating Your App
    • Authorization
    • Access Tokens
    • Refresh Tokens
    • Making API Requests
    • Dashboard UI Send To
    • Example App
    • Resources

API Reference

  • Accounts API
    • GET /widgetsget
  • Whitelabel API
    • GET /tosget
    • POST /consentAndConnectpost
    • POST /consentAndDocumentspost
    • POST /connectpost
    • GET /carriersget
    • GET /carriers/:carrierIdget
    • POST /idvpost
    • POST /idvoptionspost
    • POST /reconnectTokenpost
    • POST /servicingActionpost
  • Consent API
    • How to use Consent API
    • POST /consentpost
    • GET /tos
  • Enrichment API
    • GET /propertyDataget
    • GET /driverLicenseget
    • GET /drivingRecordIqget
    • GET /householdget
  • Policy Search API
    • How to use Policy Search API
    • POST /policySearchpost
  • Misc API
    • GET /healthget
  • Monitorings API
    • How to use Monitoring
    • GET /monitoringsget
    • POST /monitoringspost
    • PATCH /monitorings/:monitoringIdpatch
    • DELETE /monitorings/:monitoringIddel
    • GET /monitorings/:monitoringIdget
    • GET /monitorings/:monitoringId/reconnectTokenget
    • POST /monitorings/:monitoringId/refreshpost
    • GET /monitorings/:monitoringId/eventsget
  • Policy Forms API
    • GET /policyforms/:policyFormId/pdfget
  • Policy Check Team Setting API
    • GET /policyChecks/settingsget
    • POST /policyChecks/settingspost
  • Pulls API
    • GET /pulls/:pullIdget
    • PATCH /pulls/:pullIdpatch
    • GET /pullsget
    • GET /:documentId/pdfget
    • POST /policyCheckpost
    • GET /policyCheck/pdfget
  • Servicings API
    • How to use Servicing
    • GET /servicingsget
    • POST /servicingspost
    • GET /servicings/:servicingActionIdget
  • Teams API
    • GET /:teamIdget
    • DELETE /:teamIddel
    • POST /teamspost
  • Widgets API
    • POST /widgetspost
    • GET /:widgetIdget
    • PATCH /:widgetIdpatch
    • DELETE /:widgetIddel
    • PUT /:widgetId/logoput
    • PUT /:widgetId/iconput
  • Webhooks API
    • GET /webhooksget
    • POST /webhookspost
    • PATCH /webhooks/:webhookIdpatch
    • DELETE /webhooks/:webhookIddel

SDK

  • Using the SDK
  • Reference Documentation
  • Swift implementation
  • Kotlin implementation
  • React Native implementation

Webhooks

  • Using Webhooks
    • AUTH_STATUS
    • POLICY_AVAILABLE
    • POLICIES_AVAILABLE
    • COMPLETE
    • ERROR
    • MONITORING_RECONNECT
    • DATA_UPDATED
    • SERVICING_WAITING_FOR_CONSUMER_CONFIRMATION
    • MONITORING_EVENTS
  • Verifying Webhook Signatures
  • Webhook Retries

Metadata

  • Attaching metadata to a Pull with the SDK
  • Attaching metadata to a Pull using your widget link

COMPONENTS

  • Getting Started
  • Customizing Your Form
  • Reference Documentation

Schemas

  • AdditionalInterest
  • Address
  • Agent
  • AgentInfo
  • AnswerField
  • AnswerSection
  • Claim
  • CommercialNamedInsured
  • Document
  • Driver
  • DrivingRecord
  • Dwelling
  • DwellingCoverage
  • EnrichmentDriverLicense
  • EnrichmentDrivingRecordIq
  • EnrichmentHousehold
  • EnrichmentPropertyData
  • FileUpload
  • LifePolicy
  • LifePolicyBeneficiary
  • LifePolicyDetails
  • LifePolicyRider
  • Location
  • LocationCoverage
  • LocationOperation
  • LossEvent
  • Monitoring
  • MonitoringEvent
  • Mortgagee
  • NamedInsured
  • Policy
  • PolicyCheck
  • PolicyCheckDwellingSetting
  • PolicyCheckPullVehicleSetting
  • PolicyCheckVehicleSetting
  • PolicyForm
  • PremiumGroup
  • PropertyData
  • Pull
  • PullAssignee
  • PullFunnel
  • ServicingAction
  • ValidationCompleteBody
  • Vehicle
  • VehicleCoverage
  • VehicleDriver
  • Widget
Powered by 

Webhooks API

The Webhooks API enables you to manage webhooks with code. You can also manage webhooks from the Settings Page on the Canopy Connect Dashboard.

Updated 9 months ago


PUT /:widgetId/icon
GET /webhooks
Did this page help you?

Updated 9 months ago


PUT /:widgetId/icon
GET /webhooks
Did this page help you?