Subscriptions

Retrieve an event subscription for the authenticated user

Return details of a single subscription. The response is wrapped in an array even for a single subscription. An id that names no subscription visible to the authenticated user returns 200 with an empty array.

get/v1/subscriptions/{id}

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/subscriptions/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Id of the event subscription.

Response

The request succeeded.

idstring required

Id of the subscription.

subscription_idstring required

Id of the subscription, repeated for the legacy clients.

statusnumber required

Whether the subscription is active: 1 when active and -1 once it has been disabled.

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.

hoststring nullable required

Label for filtering subscriptions with the host query parameter, derived from the domain of target_url when it was not given. Events are always posted to target_url.

target_urlstring required

URL the event is posted to.

payloadstring nullable required

Extra data posted with every event, empty when none was given.

globalboolean required

Whether the subscription catches the events of every user in the entity.

notification_emailstring nullable required

Email address alerted when the delivery fails, empty when the sender is alerted instead.

created_atstring required

When the subscription was created, as yyyy-MM-dd HH:mm:ss without a time zone offset.

Changes

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