Register webhooks to receive real-time notifications of key events, such as all policy data becoming available after an end-user submits on your Canopy Connect widget.
To register a webhook, specify a web endpoint and select the event types you wish to subscribe to. Canopy Connect's infrastructure will send POST requests to the web endpoint you specify. You can register webhooks from the Settings page on the Canopy Connect dashboard or using the Webhooks API.
Each webhook request represents an event occurring on a specific data Pull. You can use the returned pull_id to fetch the complete information for the data Pull using the GET /pulls/:pullId endpoint.
Event Types
There are 5 event types you can subscribe to:
| Event Type | Description |
|---|---|
| AUTH_STATUS | This event is triggered when a Pull transitions to a new authentication state. |
| POLICY_AVAILABLE | This event is triggered when the policy data for an insurance policy becomes available. |
| POLICIES_AVAILABLE | This event triggers once per Pull, when policy data for all insurance policies is available. Does not include documents. |
| COMPLETE | This event occurs once per Pull, once all information (including documents) is available. |
| ERROR | This event is triggered when a Pull encounters an error while running. |
| MONITORING_RECONNECT | This event is triggered when a Monitoring Pull requires user input to complete authentication. |
| DATA_UPDATED | This event is triggered when data on a pull is updated or added. |
| SERVICING_WAITING_FOR_CONSUMER_CONFIRMATION | This event is triggered when a ServicingAction has been processed and is waiting for confirmation. |