Subscriptions

Trigger a test event subscription delivery

Send a test delivery of a subscription event for an existing document. Every active subscription for the event that belongs to you, to the document owner or to the whole entity receives it, and nothing is sent when there is none.

The body is built from the current state of the document and carries no event_meta, so it is not a replay of an earlier or failed delivery.

post/v1/subscriptions/test

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/subscriptions/test
  • Auth: HTTP bearer

Request body

event'document.approved' | 'document.viewed' | 'document.hardbounced' | 'document.commented' | 'document.opened' | 'document.created' | 'document.partially_signed' | 'document.forwarded' | 'document.sent' | 'document.rejected' | 'document.downloaded' | 'document.printed' | 'comment.created' | 'document.expired' | 'document.signed' | 'document.reviewed' | 'document.recalled' | 'comment.reply_created' | 'comment.resolved' | 'document.lost' | 'document.page_tracked' | 'document.partially_rejected' required

Event a webhook subscription can listen to.

document_idstring required

The document id of an existing document to trigger the event for

recipient_idstring

The recipient the test event is about, such as the viewer of document.viewed. When omitted, the first recipient of the document is used.

Response

The request succeeded.

Changes

No recorded changes to this operation across all 1 revision of this API.