This event occurs once per Pull, once all information (including documents) is available.

Webhook Request Format

The webhook is a POST request with a JSON body that will look like the following:

{
  "widget_id": "<WIDGET_ID>",
  "team_id": "<TEAM_ID>",
  "pull_id": "<PULL_ID>",
  "status": "SUCCESS",
  "meta_data": {... developer-supplied JSON-serializable metadata ...},
  "event_type": "COMPLETE",
  "account_identifier": "<ACCOUNT_IDENTIFIER>",
  "is_monitored": true,
  "monitoring": { // Only exists if is_monitored=true
    "initial_pull_id": "<PULL_ID>", // The ID of the original Pull being monitored
    "monitoring_id": "<MONITORING_ID>" // The ID of the Monitoring
  },
  "data": {}
}

COMPLETE webhook for Servicing pulls

For a servicing request, COMPLETE is sent once per request, when every ServicingAction in it reached the carrier. Its pull_type is SERVICING and its pull_id is the servicing Pull. If Canopy's servicing team is completing the request (is_manual: true from POST /servicings), COMPLETE is sent when the team finishes.

COMPLETE does not mean the changes are verified: it usually arrives while actions are still SUBMITTED or VERIFYING. Subscribe to SERVICING_STATUS_UPDATED to hear when each action reaches VERIFIED, VERIFIED_WITHOUT_DOCUMENT or VERIFICATION_FAILED.