Skip to content

Latest commit

 

History

History
432 lines (310 loc) · 13.1 KB

ObjectWebhookApi.md

File metadata and controls

432 lines (310 loc) · 13.1 KB
Raw

ObjectWebhookApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
webhookCreateObjectV2 POST /2/object/webhook Create a new Webhook
webhookDeleteObjectV1 DELETE /1/object/webhook/{pkiWebhookID} Delete an existing Webhook
webhookEditObjectV1 PUT /1/object/webhook/{pkiWebhookID} Edit an existing Webhook
webhookGetHistoryV1 GET /1/object/webhook/{pkiWebhookID}/getHistory Retrieve the logs for recent Webhook calls
webhookGetListV1 GET /1/object/webhook/getList Retrieve Webhook list
webhookGetObjectV2 GET /2/object/webhook/{pkiWebhookID} Retrieve an existing Webhook
webhookRegenerateApikeyV1 POST /1/object/webhook/{pkiWebhookID}/regenerateApikey Regenerate the Apikey
webhookTestV1 POST /1/object/webhook/{pkiWebhookID}/test Test the Webhook by calling the Url

webhookCreateObjectV2

WebhookCreateObjectV2Response webhookCreateObjectV2(webhookCreateObjectV2Request)

Create a new Webhook

The endpoint allows to create one or many elements at once.

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectWebhookApi()
val webhookCreateObjectV2Request : WebhookCreateObjectV2Request =  // WebhookCreateObjectV2Request | 
try {
    val result : WebhookCreateObjectV2Response = apiInstance.webhookCreateObjectV2(webhookCreateObjectV2Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectWebhookApi#webhookCreateObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectWebhookApi#webhookCreateObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
webhookCreateObjectV2Request WebhookCreateObjectV2Request

Return type

WebhookCreateObjectV2Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

webhookDeleteObjectV1

WebhookDeleteObjectV1Response webhookDeleteObjectV1(pkiWebhookID)

Delete an existing Webhook

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectWebhookApi()
val pkiWebhookID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : WebhookDeleteObjectV1Response = apiInstance.webhookDeleteObjectV1(pkiWebhookID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectWebhookApi#webhookDeleteObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectWebhookApi#webhookDeleteObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiWebhookID kotlin.Int

Return type

WebhookDeleteObjectV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

webhookEditObjectV1

WebhookEditObjectV1Response webhookEditObjectV1(pkiWebhookID, webhookEditObjectV1Request)

Edit an existing Webhook

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectWebhookApi()
val pkiWebhookID : kotlin.Int = 56 // kotlin.Int | 
val webhookEditObjectV1Request : WebhookEditObjectV1Request =  // WebhookEditObjectV1Request | 
try {
    val result : WebhookEditObjectV1Response = apiInstance.webhookEditObjectV1(pkiWebhookID, webhookEditObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectWebhookApi#webhookEditObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectWebhookApi#webhookEditObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiWebhookID kotlin.Int
webhookEditObjectV1Request WebhookEditObjectV1Request

Return type

WebhookEditObjectV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

webhookGetHistoryV1

WebhookGetHistoryV1Response webhookGetHistoryV1(pkiWebhookID, eWebhookHistoryinterval)

Retrieve the logs for recent Webhook calls

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectWebhookApi()
val pkiWebhookID : kotlin.Int = 56 // kotlin.Int | 
val eWebhookHistoryinterval : kotlin.String = eWebhookHistoryinterval_example // kotlin.String | The number of days to return
try {
    val result : WebhookGetHistoryV1Response = apiInstance.webhookGetHistoryV1(pkiWebhookID, eWebhookHistoryinterval)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectWebhookApi#webhookGetHistoryV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectWebhookApi#webhookGetHistoryV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiWebhookID kotlin.Int
eWebhookHistoryinterval kotlin.String The number of days to return [enum: LastDay, LastWeek]

Return type

WebhookGetHistoryV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

webhookGetListV1

WebhookGetListV1Response webhookGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve Webhook list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eWebhookModule | Ezsign<br>Management | | eWebhookEzsignevent | DocumentCompleted<br>FolderCompleted | | eWebhookManagementevent | UserCreated |

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectWebhookApi()
val eOrderBy : kotlin.String = eOrderBy_example // kotlin.String | Specify how you want the results to be sorted
val iRowMax : kotlin.Int = 56 // kotlin.Int | 
val iRowOffset : kotlin.Int = 56 // kotlin.Int | 
val acceptLanguage : HeaderAcceptLanguage =  // HeaderAcceptLanguage | 
val sFilter : kotlin.String = sFilter_example // kotlin.String | 
try {
    val result : WebhookGetListV1Response = apiInstance.webhookGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectWebhookApi#webhookGetListV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectWebhookApi#webhookGetListV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
eOrderBy kotlin.String Specify how you want the results to be sorted [optional] [enum: pkiWebhookID_ASC, pkiWebhookID_DESC, sWebhookDescription_ASC, sWebhookDescription_DESC, eWebhookEzsignevent_ASC, eWebhookEzsignevent_DESC, eWebhookManagementevent_ASC, eWebhookManagementevent_DESC, eWebhookModule_ASC, eWebhookModule_DESC, sWebhookEmailfailed_ASC, sWebhookEmailfailed_DESC, sWebhookEvent_ASC, sWebhookEvent_DESC, sWebhookUrl_ASC, sWebhookUrl_DESC, bWebhookIsactive_ASC, bWebhookIsactive_DESC, bWebhookIssigned_ASC, bWebhookIssigned_DESC]
iRowMax kotlin.Int [optional]
iRowOffset kotlin.Int [optional] [default to 0]
acceptLanguage HeaderAcceptLanguage [optional] [enum: *, en, fr]
sFilter kotlin.String [optional]

Return type

WebhookGetListV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

webhookGetObjectV2

WebhookGetObjectV2Response webhookGetObjectV2(pkiWebhookID)

Retrieve an existing Webhook

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectWebhookApi()
val pkiWebhookID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : WebhookGetObjectV2Response = apiInstance.webhookGetObjectV2(pkiWebhookID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectWebhookApi#webhookGetObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectWebhookApi#webhookGetObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiWebhookID kotlin.Int

Return type

WebhookGetObjectV2Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

webhookRegenerateApikeyV1

WebhookRegenerateApikeyV1Response webhookRegenerateApikeyV1(pkiWebhookID, webhookRegenerateApikeyV1Request)

Regenerate the Apikey

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectWebhookApi()
val pkiWebhookID : kotlin.Int = 56 // kotlin.Int | 
val webhookRegenerateApikeyV1Request : WebhookRegenerateApikeyV1Request =  // WebhookRegenerateApikeyV1Request | 
try {
    val result : WebhookRegenerateApikeyV1Response = apiInstance.webhookRegenerateApikeyV1(pkiWebhookID, webhookRegenerateApikeyV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectWebhookApi#webhookRegenerateApikeyV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectWebhookApi#webhookRegenerateApikeyV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiWebhookID kotlin.Int
webhookRegenerateApikeyV1Request WebhookRegenerateApikeyV1Request

Return type

WebhookRegenerateApikeyV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

webhookTestV1

WebhookTestV1Response webhookTestV1(pkiWebhookID, body)

Test the Webhook by calling the Url

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectWebhookApi()
val pkiWebhookID : kotlin.Int = 56 // kotlin.Int | 
val body : kotlin.Any = Object // kotlin.Any | 
try {
    val result : WebhookTestV1Response = apiInstance.webhookTestV1(pkiWebhookID, body)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectWebhookApi#webhookTestV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectWebhookApi#webhookTestV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiWebhookID kotlin.Int
body kotlin.Any

Return type

WebhookTestV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json