v1

latestOpenAPI 3.0.12026-07-269671357.0 KB

Webhooks

Get Webhook V2 Events

get/v2/webhooks/{id}/events

Path parameters

idstring required

The ID of the webhook to retrieve events for.

Query parameters

limitinteger

How many results to return. Default is 20; max is 100.

offsetinteger

Offset request by given # of items. Default is 0.

Response

Webhook events retrieved

event'transaction.*' | 'transaction.created' | 'transaction.sent' | 'transaction.updated' | 'transaction.received' | 'transaction.completed' | 'transaction.completed_with_rejections' | 'transaction.partially_completed' | 'transaction.deleted' | 'transaction.recalled' | 'transaction.expired' | 'transaction.released' | 'transaction.held_for_review' | 'transaction.declined' | 'transaction.reviewed' | 'transaction.sent_to_closing_ops' | 'transaction.sent_to_signer' | 'transaction.sent_to_title_agency' | 'transaction.document.upload' | 'transaction.document.processed' | 'transaction.import.processed' | 'transaction.import.failed' | 'transaction.meeting.created' | 'transaction.meeting.failed' | 'transaction.meeting.requested' | 'transaction.meeting.video.processed' | 'transaction.notary.assigned' | 'transaction.signer.kba_failed' | 'transaction.signer.kba_passed' | 'transaction.signer.high_risk_detected' | 'transaction.signer.medium_risk_detected' | 'transaction.transaction.automated_identity_verification_by_idv_service_failed' | 'transaction.transaction.automated_identity_verification_by_idv_service_passed' | 'transaction.underwriter.not_available' | 'notary.*' | 'notary.created' | 'notary.needs_review' | 'notary.compliant' | 'notary.non_compliant' | 'notary.signer_ready'

The Webhook V2 event type. See our Webhooks V2 guide for a list of valid events.

deliveredstring

The date and time of the event delivery in ISO-8601 format.

payloadstring

The payload of the event.