WebhookBody
| field | type | description | properties |
|---|---|---|---|
| widget_id | string(uuid) | ||
| team_id | string(uuid) | ||
| pull_id | string(uuid) | ||
| status | Pull Status. Certain statuses correspond with a certain type:- GETTING_CONSUMERS and PULLING_DATA are for PULLING_DATA pulls only.- SERVICING, WAITING_FOR_CONSUMER_CONFIRMATION, SUBMITTING_CONFIRMATION and VALIDATION_ERROR are for SERVICING pulls only.- All other statuses can be present on any pull type. | enum: STARTED, QUEUED, DOCUMENT_PARSING, PROCESSING, IDENTITY_VERIFICATION_OPTIONS, IDENTITY_VERIFICATION, GETTING_CONSUMERS, PULLING_DATA, SERVICING, WAITING_FOR_CONSUMER_CONFIRMATION, SUBMITTING_CONFIRMATION, NOT_AUTHENTICATED, INTERNAL_ERROR, PROVIDER_ERROR, VALIDATION_ERROR, SUCCESS, INCOMPLETE, WAITING_FOR_CARRIER | |
| meta_data | object | ||
| pull_type | string | Type of the Pull. SERVICING for webhooks about a servicing request; their pull_id is the servicing Pull, not the Pull you requested servicing for. | |
| event_type | SERVICING_WAITING_FOR_CONSUMER_CONFIRMATION is deprecated and no longer sent: servicing never waits on the consumer. Webhooks subscribed to it keep working. | enum: COMPLETE, POLICIES_AVAILABLE, POLICY_AVAILABLE, AUTH_STATUS, ERROR, MONITORING_RECONNECT, DATA_UPDATED, SERVICING_STATUS_UPDATED, SERVICING_WAITING_FOR_CONSUMER_CONFIRMATION, VALIDATION_COMPLETE | |
| account_identifier | string | null | Unique identifier for online account holder that will stay the same across PULLING_DATA pulls | |
| is_monitored | boolean | ||
| monitoring | object | null | This will only exist when is_monitored is true | |
| data | object | Data type will match the event_type |