Skip to content

Latest commit

 

History

History
335 lines (222 loc) · 7.76 KB

WebhooksApi.md

File metadata and controls

335 lines (222 loc) · 7.76 KB

SignrequestClient.WebhooksApi

All URIs are relative to https://signrequest.com/api/v1

Method HTTP request Description
webhooksCreate POST /webhooks/ Create a Webhook
webhooksDelete DELETE /webhooks/{uuid}/ Delete a Webhook
webhooksList GET /webhooks/ Retrieve a list of Webhooks
webhooksPartialUpdate PATCH /webhooks/{uuid}/ Partially update a Webhook
webhooksRead GET /webhooks/{uuid}/ Retrieve a Webhook
webhooksUpdate PUT /webhooks/{uuid}/ Update a Webhook

webhooksCreate

WebhookSubscription webhooksCreate(data)

Create a Webhook

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.WebhooksApi();

var data = new SignrequestClient.WebhookSubscription(); // WebhookSubscription | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.webhooksCreate(data, callback);

Parameters

Name Type Description Notes
data WebhookSubscription

Return type

WebhookSubscription

Authorization

Token

HTTP request headers

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

webhooksDelete

webhooksDelete(uuid, )

Delete a Webhook

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.WebhooksApi();

var uuid = "uuid_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.webhooksDelete(uuid, , callback);

Parameters

Name Type Description Notes
uuid String

Return type

null (empty response body)

Authorization

Token

HTTP request headers

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

webhooksList

InlineResponse2009 webhooksList(opts)

Retrieve a list of Webhooks

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.WebhooksApi();

var opts = { 
  'page': 56, // Number | A page number within the paginated result set.
  'limit': 56 // Number | Number of results to return per page.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.webhooksList(opts, callback);

Parameters

Name Type Description Notes
page Number A page number within the paginated result set. [optional]
limit Number Number of results to return per page. [optional]

Return type

InlineResponse2009

Authorization

Token

HTTP request headers

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

webhooksPartialUpdate

WebhookSubscription webhooksPartialUpdate(uuid, data)

Partially update a Webhook

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.WebhooksApi();

var uuid = "uuid_example"; // String | 

var data = new SignrequestClient.WebhookSubscription(); // WebhookSubscription | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.webhooksPartialUpdate(uuid, data, callback);

Parameters

Name Type Description Notes
uuid String
data WebhookSubscription

Return type

WebhookSubscription

Authorization

Token

HTTP request headers

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

webhooksRead

WebhookSubscription webhooksRead(uuid, )

Retrieve a Webhook

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.WebhooksApi();

var uuid = "uuid_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.webhooksRead(uuid, , callback);

Parameters

Name Type Description Notes
uuid String

Return type

WebhookSubscription

Authorization

Token

HTTP request headers

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

webhooksUpdate

WebhookSubscription webhooksUpdate(uuid, data)

Update a Webhook

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.WebhooksApi();

var uuid = "uuid_example"; // String | 

var data = new SignrequestClient.WebhookSubscription(); // WebhookSubscription | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.webhooksUpdate(uuid, data, callback);

Parameters

Name Type Description Notes
uuid String
data WebhookSubscription

Return type

WebhookSubscription

Authorization

Token

HTTP request headers

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