webhooks

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Query parameters

accountstring

account

cursorinteger

The pagination cursor value.

document_eventsstring

document_events

format'json' | 'xlsx'
orderingstring

Which field to use when ordering the results.

page_sizeinteger

Number of results to return per page.

review_eventsstring

review_events

searchstring

A search term.

signature_eventsstring

signature_events

state'inactive' | 'active' | 'disabled'

state

task_eventsstring

task_events

versionstring

version

Response

idstring uuid required
urlstring uri required
accountstring uri required
namestring required
version'2.4.13' | '2.4.12' | '2.4.11' | '2.4.10' | '2.4.9' | '2.4.8' | '2.4.7' | '2.4.6' | '2.4.5' | '2.4.4' | '2.4.3' | '2.4.2' | '2.4.1' | '2.3.5' | '2.3.4' | '2.3.3' | '2.3.2' | '2.3.1' | '2.3.0' | '2.2.6' | '2.2.5' | '2.2.4' | '2.2.3' | '2.2.2' | '2.2.1' | '2.2.0' | '2.1.1' | '2.1.0' | '2.0.0' | '1.1.0' | '1.0.0'
state'inactive' | 'active' | 'disabled' required
headersobject
targetstring uri required
task_eventsboolean
document_eventsboolean
signature_eventsboolean
review_eventsboolean
notification_emailsstring[]
failure_countinteger required
disable_messagestring required
shared_secretstring
activated_atstring date-time required
disabled_atstring date-time required
created_atstring date-time required
updated_atstring date-time required

Changes

    • warning

      added the new 2.4.13 enum value to the / response property for the response status (media type: application/json; version=2.4.13)

    • warning

      added the new 2.4.13 enum value to the / response property for the response status (media type: application/xlsx; version=2.4.13)

    • info

      media type application/json; version=2.4.12 was changed to application/json; version=2.4.13 for the response status

    • info

      media type application/xlsx; version=2.4.12 was changed to application/xlsx; version=2.4.13 for the response status

    • warning

      added the new 2.4.12 enum value to the / response property for the response status (media type: application/json; version=2.4.12)

    • warning

      added the new 2.4.12 enum value to the / response property for the response status (media type: application/xlsx; version=2.4.12)

    • info

      media type application/json; version=2.4.11 was changed to application/json; version=2.4.12 for the response status

    • info

      media type application/xlsx; version=2.4.11 was changed to application/xlsx; version=2.4.12 for the response status