Send a test event to a webhook
Sends a webhook.test event to this webhook only, signed and delivered like any other event in the webhook’s API version, and returns the delivery with status: PENDING. data.object is the webhook’s id and url. Follow the delivery with GET /api/v1/webhooks/:id/deliveries/:deliveryId. The event isn’t listed in GET /api/v1/events, and no other webhook receives it.
Returns 409 INVALID_STATE when the webhook is disabled or paused.
Plan Requirement: Requires the Team plan or higher, or a sandbox organization.
Authorizations
Headers
ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.
Response
200
The event type, such as document.completed. Null for an event type that 2026-10 no longer has.
document.created, document.sent, document.fully_signed, document.completed, document.rejected, document.expired, document.withdrawn, document.updated, document.deleted, document.restored, document.archived, document.unarchived, document.expiration_extended, document.expiring_soon, document.party.sent, document.party.delivery_failed, document.party.opened, document.party.read, document.party.signed, document.party.rejected, document.party.delegated, document.party.auth_failed, document.party.verified, document.party.updated, document.party.added, document.party.removed, document.party.reminded, document.comment.created, bundle.sent, bundle.party.signed, bundle.completed, bundle.cancelled, archive_import.completed, archive_import.undone, identity_check.created, identity_check.sent, identity_check.opened, identity_check.verified, identity_check.failed, identity_check.cancelled, contact.created, contact.updated, contact.deleted, company.created, company.updated, company.deleted, template.created, template.updated, template.deleted, template.restored, form.submitted, workspace.created, member.added, member.invited, member.invite_accepted, approval_request.created, approval_request.approved, approval_request.rejected, approval_request.cancelled, login.completed, login.failed, security.document_downloaded, security.documents_exported, security.signature_identity_accessed, security.member_removed, security.member_role_changed, security.role_updated, security.workspace_retention_updated, usage.limit_reached, webhook.test, null 
