PApandadoc
Webhook events

Webhook Event Details

Changed on

This operation fetches detailed information about a specific webhook event using its unique identifier.

get/public/v1/webhook-events/{id}

Request

Path parameters

idstring uuid required

Webhook event uuid.

Response

Get webhook event by uuid.

uuidstring uuid nullable

Unique webhook subscription event identifier

namestring

Webhook subscription name

type'recipient_completed' | 'document_updated' | 'document_deleted' | 'document_state_changed' | 'document_creation_failed' | 'document_completed_pdf_ready' | 'document_section_added' | 'quote_updated' | 'template_created' | 'template_updated' | 'template_deleted' | 'content_library_item_created' | 'content_library_item_creation_failed' | 'recipient_qes_verified'
http_status_codeinteger nullable

Webhook subscription event response http status code

error'INTERNAL_ERROR' | 'NOT_VALID_URL' | 'CONNECT_ERROR' | 'TIMEOUT_ERROR' nullable
delivery_timestring date-time

Webhook subscription event delivery time

urlstring

Webhook subscription event destination url

signaturestring

Webhook subscription event digital signature

request_bodystring

Webhook subscription event request body

response_bodystring nullable

Webhook subscription response body

response_headersstring nullable

Webhook subscription response headers

event_timestring date-time

Webhook subscription event trigger time

Example response

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Subscription",
  "type": "document_state_changed",
  "http_status_code": 200,
  "error": "TIMEOUT_ERROR",
  "delivery_time": "2022-06-20T15:04:59.424730Z",
  "url": "https://example.com",
  "signature": "587c22285F57883db3ee",
  "request_body": "[{\\\"event\\\":\\\"document_state_changed\\\"}]",
  "response_body": "<!doctype html>\\n<html>\\n</html>",
  "response_headers": "[cache-control:\\\"max-age=604800\\\"]",
  "event_time": "2022-06-20T15:04:58.424730Z"
}

Changes

  • b9a306b1a421Revision changes
    • warning

      added the new recipient_qes_verified enum value to the response property for the response status