Skip to content

CustomWebhookResponse.md

Latest commit

 

History

History
62 lines (56 loc) · 3.47 KB

CustomWebhookResponse.md

File metadata and controls

62 lines (56 loc) · 3.47 KB

EzmaxApi::CustomWebhookResponse

Properties

Name Type Description Notes
pki_webhook_id Integer The unique ID of the Webhook
fki_authenticationexternal_id Integer The unique ID of the Authenticationexternal [optional]
s_webhook_description String The description of the Webhook
fki_ezsignfoldertype_id Integer The unique ID of the Ezsignfoldertype. [optional]
s_ezsignfoldertype_name_x String The name of the Ezsignfoldertype in the language of the requester [optional]
e_webhook_module FieldEWebhookModule
e_webhook_ezsignevent FieldEWebhookEzsignevent [optional]
e_webhook_managementevent FieldEWebhookManagementevent [optional]
s_webhook_url String The URL of the Webhook callback
s_webhook_emailfailed String The email that will receive the Webhook in case all attempts fail
s_webhook_apikey String The Apikey for the Webhook. This will be hidden if we are not creating or regenerating the Apikey. [optional]
s_webhook_secret String The Secret for the Webhook. This will be hidden if we are not creating or regenerating the Apikey. [optional]
b_webhook_isactive Boolean Whether the Webhook is active or not
b_webhook_issigned Boolean Whether the requests will be signed or not
b_webhook_skipsslvalidation Boolean Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use
s_authenticationexternal_description String The description of the Authenticationexternal [optional]
obj_audit CommonAudit
s_webhook_event String The concatenated string to describe the Webhook event [optional]
s_webhook_authentificationexternalerror String Error message when token renewal failed or is not configured. Only if an Authenticationexternal is set. [optional]
a_obj_webhookheader Array<WebhookheaderResponseCompound> [optional]
pks_customer_code String The customer code assigned to your account
b_webhook_test Boolean Wheter the webhook received is a manual test or a real event
e_webhook_emittype String Wheter the webhook received is a manual test or a real event [optional]

Example

require 'Ezmaxapi'

instance = EzmaxApi::CustomWebhookResponse.new(
  pki_webhook_id: 77,
  fki_authenticationexternal_id: 56,
  s_webhook_description: Import into our system,
  fki_ezsignfoldertype_id: 5,
  s_ezsignfoldertype_name_x: Default,
  e_webhook_module: null,
  e_webhook_ezsignevent: null,
  e_webhook_managementevent: null,
  s_webhook_url: https://www.example.com,
  s_webhook_emailfailed: email@example.com,
  s_webhook_apikey: null,
  s_webhook_secret: null,
  b_webhook_isactive: true,
  b_webhook_issigned: true,
  b_webhook_skipsslvalidation: false,
  s_authenticationexternal_description: Authentification,
  obj_audit: null,
  s_webhook_event: Ezsign-DocumentCompleted,
  s_webhook_authentificationexternalerror: expired access/refresh token,
  a_obj_webhookheader: null,
  pks_customer_code: demo,
  b_webhook_test: null,
  e_webhook_emittype: null
)