Skip to content

Latest commit

 

History

History
33 lines (29 loc) · 2.56 KB

CustomWebhookResponse.md

File metadata and controls

33 lines (29 loc) · 2.56 KB

eZmaxApi.Model.CustomWebhookResponse

A custom Webhook object

Properties

Name Type Description Notes
PkiWebhookID int The unique ID of the Webhook
FkiAuthenticationexternalID int The unique ID of the Authenticationexternal [optional]
SWebhookDescription string The description of the Webhook
FkiEzsignfoldertypeID int The unique ID of the Ezsignfoldertype. [optional]
SEzsignfoldertypeNameX string The name of the Ezsignfoldertype in the language of the requester [optional]
EWebhookModule FieldEWebhookModule
EWebhookEzsignevent FieldEWebhookEzsignevent [optional]
EWebhookManagementevent FieldEWebhookManagementevent [optional]
SWebhookUrl string The URL of the Webhook callback
SWebhookEmailfailed string The email that will receive the Webhook in case all attempts fail
SWebhookApikey string The Apikey for the Webhook. This will be hidden if we are not creating or regenerating the Apikey. [optional]
SWebhookSecret string The Secret for the Webhook. This will be hidden if we are not creating or regenerating the Apikey. [optional]
BWebhookIsactive bool Whether the Webhook is active or not
BWebhookIssigned bool Whether the requests will be signed or not
BWebhookSkipsslvalidation bool Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use
SAuthenticationexternalDescription string The description of the Authenticationexternal [optional]
ObjAudit CommonAudit
SWebhookEvent string The concatenated string to describe the Webhook event [optional]
SWebhookAuthentificationexternalerror string Error message when token renewal failed or is not configured. Only if an Authenticationexternal is set. [optional]
AObjWebhookheader List<WebhookheaderResponseCompound> [optional]
PksCustomerCode string The customer code assigned to your account
BWebhookTest bool Wheter the webhook received is a manual test or a real event
EWebhookEmittype string Wheter the webhook received is a manual test or a real event [optional]

[Back to Model list] [Back to API list] [Back to README]